openapi-directory/api/azure.com/maps-maps-management.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Resource Provider","title":"Azure Maps Resource Provider","version":"2018-05-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-ms-code-generation-settings":{"name":"MapsManagementClient"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"maps-maps-management","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Maps/operations":{"get":{"description":"List operations available for the Maps Resource Provider","operationId":"Accounts_ListOperations","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsOperations"},"examples":{"GetOperations":{"$ref":"#/components/examples/GetOperations"}}}}},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ms-pageable":{"itemName":"value"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Maps/accounts":{"get":{"description":"Get all Maps Accounts in a Subscription","operationId":"Accounts_ListBySubscription","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccounts"},"examples":{"ListAccountsBySubscription":{"$ref":"#/components/examples/ListAccountsBySubscription"}}}}},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ms-pageable":{"itemName":"value"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources":{"post":{"description":"Moves Maps Accounts from one ResourceGroup (or Subscription) to another","operationId":"Accounts_Move","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"description":"The name of the resource group that contains Maps Account to move.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"MoveAccounts":{"value":"myResourceGroup"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccountsMoveRequest"}}},"description":"The details of the Maps Account move.","required":true},"responses":{"200":{"description":"The Accounts were successfully moved."},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts":{"get":{"description":"Get all Maps Accounts in a Resource Group","operationId":"Accounts_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"}],"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccounts"},"examples":{"ListAccountsByResourceGroup":{"$ref":"#/components/examples/ListAccountsByResourceGroup"}}}}},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ms-pageable":{"itemName":"value"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}":{"delete":{"description":"Delete a Maps Account.","operationId":"Accounts_Delete","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"}],"responses":{"200":{"description":"The Account was deleted successfully."},"204":{"description":"The specified Account was not found. Nothing was deleted."},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"description":"Get a Maps Account.","operationId":"Accounts_Get","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"}],"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccount"},"examples":{"GetAccount":{"$ref":"#/components/examples/GetAccount"}}}}},"404":{"description":"The specified Account does not exist."},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"description":"Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku and Tags.","operationId":"Accounts_Update","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccountUpdateParameters"}}},"description":"The updated parameters for the Maps Account.","required":true},"responses":{"200":{"description":"The Account was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccount"},"examples":{"UpdateAccount":{"$ref":"#/components/examples/UpdateAccount"}}}}},"404":{"description":"The specified Account was not found. Nothing was updated."},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"description":"Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.","operationId":"Accounts_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccountCreateParameters"}}},"description":"The new or updated parameters for the Maps Account.","required":true},"responses":{"200":{"description":"The Account was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccount"},"examples":{"CreateAccount":{"$ref":"#/components/examples/CreateAccount"}}}}},"201":{"description":"The Account was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccount"},"examples":{"CreateAccount":{"$ref":"#/components/examples/CreateAccount"}}}}},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listKeys":{"post":{"description":"Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.","operationId":"Accounts_ListKeys","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"}],"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccountKeys"},"examples":{"ListKeys":{"$ref":"#/components/examples/ListKeys"}}}}},"404":{"description":"The specified Account does not exist."},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey":{"post":{"description":"Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.","operationId":"Accounts_RegenerateKeys","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/AccountNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsKeySpecification"}}},"description":"Which key to regenerate:  primary or secondary.","required":true},"responses":{"200":{"description":"The request was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapsAccountKeys"},"examples":{"RegenerateKey":{"$ref":"#/components/examples/RegenerateKey"}}}}},"404":{"description":"The specified Account does not exist."},"default":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"GetOperations":{"value":{"value":[{"display":{"description":"Register the provider","operation":"Register the provider","provider":"Microsoft Maps","resource":"Maps Account"},"name":"Microsoft.Maps/register/action"},{"display":{"description":"Create or update a Maps Account.","operation":"Create or update a Maps Account.","provider":"Microsoft Maps","resource":"Maps Account"},"name":"Microsoft.Maps/accounts/write"},{"display":{"description":"Get a Maps Account.","operation":"Get a Maps Account.","provider":"Microsoft Maps","resource":"Maps Account"},"name":"Microsoft.Maps/accounts/read"},{"display":{"description":"Delete a Maps Account.","operation":"Delete a Maps Account.","provider":"Microsoft Maps","resource":"Maps Account"},"name":"Microsoft.Maps/accounts/delete"},{"display":{"description":"List Maps Account keys","operation":"List keys","provider":"Microsoft Maps","resource":"Maps Account"},"name":"Microsoft.Maps/accounts/listKeys/action"},{"display":{"description":"Generate new Maps Account primary or secondary key","operation":"Generate new primary or secondary key","provider":"Microsoft Maps","resource":"Maps Account"},"name":"Microsoft.Maps/accounts/regenerateKey/action"}]}},"ListAccountsBySubscription":{"value":{"value":[{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2","location":"global","name":"myMapsAccount2","sku":{"name":"S0","tier":"Standard"},"tags":{"test":"true"},"type":"Microsoft.Maps/accounts"},{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount","location":"global","name":"myMapsAccount","sku":{"name":"S0","tier":"Standard"},"tags":{"test":"true"},"type":"Microsoft.Maps/accounts"}]}},"ListAccountsByResourceGroup":{"value":{"value":[{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount2","location":"global","name":"myMapsAccount2","sku":{"name":"S0","tier":"Standard"},"tags":{"test":"true"},"type":"Microsoft.Maps/accounts"},{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount","location":"global","name":"myMapsAccount","sku":{"name":"S0","tier":"Standard"},"tags":{"test":"true"},"type":"Microsoft.Maps/accounts"}]}},"GetAccount":{"value":{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount","location":"global","name":"myMapsAccount","properties":{"x-ms-client-id":"string"},"sku":{"name":"S0","tier":"Standard"},"tags":{"test":"true"},"type":"Microsoft.Maps/accounts"}},"UpdateAccount":{"value":{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount","location":"global","name":"myMapsAccount","properties":{"x-ms-client-id":"string"},"sku":{"name":"S0","tier":"Standard"},"tags":{"specialTag":"true"},"type":"Microsoft.Maps/accounts"}},"CreateAccount":{"value":{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount","location":"global","name":"myMapsAccount","properties":{"x-ms-client-id":"string"},"sku":{"name":"S0","tier":"Standard"},"tags":{"test":"true"},"type":"Microsoft.Maps/accounts"}},"ListKeys":{"value":{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount","primaryKey":"ZiBllKWCwXXLTO13S2TaoHoK8kPFYaoyYlAcnCcE4PQ","secondaryKey":"cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU"}},"RegenerateKey":{"value":{"id":"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Maps/accounts/myMapsAccount","primaryKey":"uj0yqjjz8zG3IOSWvb_smi1q1QenGtupAqrOA1zCO6s","secondaryKey":"cJHpmUGNaGGO8H59p6NKGhfff9VjD278-2bi5wo0_mU"}}},"parameters":{"AccountNameParameter":{"description":"The name of the Maps Account.","in":"path","name":"accountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"DeleteAccount":{"value":"myMapsAccount"},"GetAccount":{"value":"myMapsAccount"},"UpdateAccount":{"value":"myMapsAccount"},"CreateAccount":{"value":"myMapsAccount"},"ListKeys":{"value":"myMapsAccount"},"RegenerateKey":{"value":"myMapsAccount"}}},"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetOperations":{"value":"2018-05-01"},"ListAccountsBySubscription":{"value":"2018-05-01"},"MoveAccounts":{"value":"2018-05-01"},"ListAccountsByResourceGroup":{"value":"2018-05-01"},"DeleteAccount":{"value":"2018-05-01"},"GetAccount":{"value":"2018-05-01"},"UpdateAccount":{"value":"2018-05-01"},"CreateAccount":{"value":"2018-05-01"},"ListKeys":{"value":"2018-05-01"},"RegenerateKey":{"value":"2018-05-01"}}},"ResourceGroupNameParameter":{"description":"The name of the Azure Resource Group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ListAccountsByResourceGroup":{"value":"myResourceGroup"},"DeleteAccount":{"value":"myResourceGroup"},"GetAccount":{"value":"myResourceGroup"},"UpdateAccount":{"value":"myResourceGroup"},"CreateAccount":{"value":"myResourceGroup"},"ListKeys":{"value":"myResourceGroup"},"RegenerateKey":{"value":"myResourceGroup"}}},"SubscriptionIdParameter":{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ListAccountsBySubscription":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"MoveAccounts":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"ListAccountsByResourceGroup":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"DeleteAccount":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"GetAccount":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"UpdateAccount":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"CreateAccount":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"ListKeys":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"},"RegenerateKey":{"value":"21a9967a-e8a9-4656-a70b-96ff1c4d05a0"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Error":{"description":"This object is returned when an error occurs in the Maps API","properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"details":{"description":"If available, a list of additional details about the error.","items":{"properties":{"code":{"description":"Error code.","readOnly":true,"type":"string"},"message":{"description":"If available, a human readable description of the error.","readOnly":true,"type":"string"},"target":{"description":"If available, the component generating the error.","readOnly":true,"type":"string"}},"type":"object"},"readOnly":true,"type":"array"},"message":{"description":"If available, a human readable description of the error.","readOnly":true,"type":"string"},"target":{"description":"If available, the component generating the error.","readOnly":true,"type":"string"}},"type":"object"},"MapsAccount":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"An Azure resource which represents access to a suite of Maps REST APIs.","properties":{"location":{"description":"The location of the resource.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/MapsAccountProperties"},"sku":{"$ref":"#/components/schemas/Sku"},"tags":{"additionalProperties":{"type":"string"},"description":"Gets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.","readOnly":true,"type":"object"}},"type":"object"},"MapsAccountCreateParameters":{"description":"Parameters used to create a new Maps Account.","properties":{"location":{"description":"The location of the resource.","type":"string"},"sku":{"$ref":"#/components/schemas/Sku"},"tags":{"additionalProperties":{"type":"string"},"description":"Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.","type":"object"}},"required":["location","sku"],"type":"object"},"MapsAccountKeys":{"description":"The set of keys which can be used to access the Maps REST APIs. Two keys are provided for key rotation without interruption.","properties":{"id":{"description":"The full Azure resource identifier of the Maps Account.","readOnly":true,"type":"string"},"primaryKey":{"description":"The primary key for accessing the Maps REST APIs.","readOnly":true,"type":"string"},"secondaryKey":{"description":"The secondary key for accessing the Maps REST APIs.","readOnly":true,"type":"string"}},"type":"object"},"MapsAccountProperties":{"description":"Additional Map account properties","properties":{"x-ms-client-id":{"description":"A unique identifier for the maps account","type":"string"}}},"MapsAccountUpdateParameters":{"description":"Parameters used to update an existing Maps Account.","properties":{"sku":{"$ref":"#/components/schemas/Sku"},"tags":{"additionalProperties":{"type":"string"},"description":"Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.","type":"object"}},"type":"object"},"MapsAccounts":{"description":"A list of Maps Accounts.","properties":{"value":{"description":"a Maps Account.","items":{"$ref":"#/components/schemas/MapsAccount"},"readOnly":true,"type":"array"}},"type":"object"},"MapsAccountsMoveRequest":{"description":"The description of what resources to move between resource groups.","properties":{"resourceIds":{"description":"A list of resource names to move from the source resource group.","items":{"type":"string"},"type":"array"},"targetResourceGroup":{"description":"The name of the destination resource group.","type":"string"}},"required":["targetResourceGroup","resourceIds"],"type":"object"},"MapsKeySpecification":{"description":"Whether the operation refers to the primary or secondary key.","properties":{"keyType":{"description":"Whether the operation refers to the primary or secondary key.","enum":["primary","secondary"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"KeyType"}}},"required":["keyType"],"type":"object"},"MapsOperations":{"description":"The set of operations available for Maps.","properties":{"value":{"description":"An operation available for Maps.","items":{"properties":{"display":{"description":"The human-readable description of the operation.","properties":{"description":{"description":"The description of the operation.","readOnly":true,"type":"string"},"operation":{"description":"The action that users can perform, based on their permission level.","readOnly":true,"type":"string"},"provider":{"description":"Service provider: Microsoft Maps.","readOnly":true,"type":"string"},"resource":{"description":"Resource on which the operation is performed.","readOnly":true,"type":"string"}},"type":"object"},"name":{"description":"Operation name: {provider}/{resource}/{operation}.","readOnly":true,"type":"string"},"origin":{"description":"The origin of the operation.","readOnly":true,"type":"string"}},"type":"object"},"readOnly":true,"type":"array"}},"type":"object"},"Resource":{"description":"An Azure resource","properties":{"id":{"description":"The fully qualified Maps Account resource identifier.","readOnly":true,"type":"string"},"name":{"description":"The name of the Maps Account, which is unique within a Resource Group.","readOnly":true,"type":"string"},"type":{"description":"Azure resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true},"Sku":{"description":"The SKU of the Maps Account.","properties":{"name":{"description":"The name of the SKU, in standard format (such as S0).","type":"string"},"tier":{"description":"Gets the sku tier. This is based on the SKU name.","readOnly":true,"type":"string"}},"required":["name"]}}}}