Azure Maps Accounts API

The Accounts API from Azure Maps — 6 operation(s) for accounts.

GitHub OpenAPI

Operations 9

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName} Accounts create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName} Accounts update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName} Accounts delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName} Accounts get #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts Accounts list by resource group #
GET /subscriptions/{subscriptionId}/providers/Microsoft.Maps/accounts Accounts list by subscription #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listSas Accounts list sas #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listKeys Accounts list keys #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey Accounts regenerate keys #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-maps:microsoft-azure-maps-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-maps-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Azure Maps Resource Provider Accounts API
  description: Resource Provider
  version: '2023-06-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Accounts
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}:
    put:
      tags:
      - Accounts
      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'
      responses:
        '200':
          description: The Account was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapsAccount'
        '201':
          description: The Account was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapsAccount'
        default:
          description: An error occurred during creating or updating the Account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapsAccount'
        description: The new or updated parameters for the Maps Account.
        required: true
      summary: Accounts create or update
      x-summary-source: derived
    patch:
      tags:
      - Accounts
      description: Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.
      operationId: Accounts_Update
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/AccountNameParameter'
      responses:
        '200':
          description: The Account was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapsAccount'
        default:
          description: An error occurred during creating or updating the Account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapsAccountUpdateParameters'
        description: The updated parameters for the Maps Account.
        required: true
      summary: Accounts update
      x-summary-source: derived
    delete:
      tags:
      - Accounts
      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/ErrorResponse'
      summary: Accounts delete
      x-summary-source: derived
    get:
      tags:
      - Accounts
      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'
        default:
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Accounts get
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts:
    get:
      tags:
      - Accounts
      description: Get all Maps Accounts in a Resource Group
      operationId: Accounts_ListByResourceGroup
      x-ms-pageable:
        nextLinkName: nextLink
      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'
        default:
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Accounts list by resource group
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.Maps/accounts:
    get:
      tags:
      - Accounts
      description: Get all Maps Accounts in a Subscription
      operationId: Accounts_ListBySubscription
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapsAccounts'
        default:
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Accounts list by subscription
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listSas:
    post:
      tags:
      - Accounts
      description: 'Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token.


        Prerequisites:

        1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account.

        2. Create or update an Azure Map account with the same Azure region as the User Assigned Managed Identity is placed.'
      operationId: Accounts_ListSas
      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/MapsAccountSasToken'
        default:
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountSasParameters'
        description: The updated parameters for the Maps Account.
        required: true
      summary: Accounts list sas
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/listKeys
  : post:
      tags:
      - Accounts
      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'
        default:
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Accounts list keys
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maps/accounts/{accountName}/regenerateKey
  : post:
      tags:
      - Accounts
      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'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapsAccountKeys'
        default:
          description: An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapsKeySpecification'
        description: 'Which key to regenerate:  primary or secondary.'
        required: true
      summary: Accounts regenerate keys
      x-summary-source: derived
components:
  schemas:
    encryption:
      type: object
      description: (Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled.
      properties:
        infrastructureEncryption:
          type: string
          description: Values are enabled and disabled.
          enum:
          - enabled
          - disabled
          x-ms-enum:
            name: InfrastructureEncryption
            modelAsString: true
        customerManagedKeyEncryption:
          $ref: '#/components/schemas/customerManagedKeyEncryption'
          description: All Customer-managed key encryption properties for the resource.
    Kind:
      description: The Kind of the Maps Account.
      type: string
      default: Gen1
      enum:
      - Gen1
      - Gen2
      x-ms-enum:
        name: kind
        modelAsString: true
    MapsAccounts:
      description: A list of Maps Accounts.
      type: object
      properties:
        value:
          description: a Maps Account.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/MapsAccount'
        nextLink:
          description: 'URL client should use to fetch the next page (per server side paging).

            It''s null for now, added for future use.'
          type: string
    MapsAccount:
      description: An Azure resource which represents access to a suite of Maps REST APIs.
      type: object
      properties:
        sku:
          description: The SKU of this account.
          $ref: '#/components/schemas/Sku'
        kind:
          description: Get or Set Kind property.
          $ref: '#/components/schemas/Kind'
        systemData:
          $ref: '#/components/schemas/systemData'
        identity:
          $ref: '#/components/schemas/ManagedServiceIdentity'
        properties:
          description: The map account properties.
          $ref: '#/components/schemas/MapsAccountProperties'
      required:
      - sku
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
      x-ms-azure-resource: true
    ErrorResponse:
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      type: object
      properties:
        error:
          description: The error object.
          $ref: '#/components/schemas/ErrorDetail'
    LinkedResource:
      type: object
      properties:
        uniqueName:
          type: string
          description: A provided name which uniquely identifies the linked resource.
        id:
          type: string
          description: 'ARM resource id in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}''.'
      required:
      - uniqueName
      - id
      description: Linked resource is reference to a resource deployed in an Azure subscription, add the linked resource `uniqueName` value as an optional parameter for operations on Azure Maps Geospatial REST APIs.
    ManagedServiceIdentity:
      type: object
      description: Managed service identity (system assigned and/or user assigned identities)
      properties:
        principalId:
          type: string
          format: uuid
          description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
          readOnly: true
        tenantId:
          type: string
          format: uuid
          description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
          readOnly: true
        type:
          $ref: '#/components/schemas/ManagedServiceIdentityType'
        userAssignedIdentities:
          $ref: '#/components/schemas/UserAssignedIdentities'
      required:
      - type
    MapsAccountProperties:
      description: Additional Map account properties
      type: object
      properties:
        uniqueId:
          description: A unique identifier for the maps account
          type: string
          readOnly: true
        disableLocalAuth:
          description: Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage.
          type: boolean
          default: false
        provisioningState:
          type: string
          description: 'The provisioning state of the Map account resource, Account updates can only be performed on terminal states. Terminal states: `Succeeded` and `Failed`'
          readOnly: true
        linkedResources:
          $ref: '#/components/schemas/LinkedResources'
        cors:
          $ref: '#/components/schemas/CorsRules'
          description: Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.
        encryption:
          $ref: '#/components/schemas/encryption'
    CorsRule:
      type: object
      properties:
        allowedOrigins:
          type: array
          items:
            type: string
          description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains
      required:
      - allowedOrigins
      description: Specifies a CORS rule for the Map Account.
    MapsKeySpecification:
      description: Whether the operation refers to the primary or secondary key.
      type: object
      required:
      - keyType
      properties:
        keyType:
          type: string
          enum:
          - primary
          - secondary
          x-ms-enum:
            name: KeyType
            modelAsString: true
          description: Whether the operation refers to the primary or secondary key.
    TrackedResource:
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      type: object
      properties:
        tags:
          type: object
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
          description: Resource tags.
        location:
          type: string
          x-ms-mutability:
          - read
          - create
          description: The geo-location where the resource lives
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
    LinkedResources:
      type: array
      maxItems: 10
      items:
        $ref: '#/components/schemas/LinkedResource'
      description: The array of associated resources to the Map account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Map Account Managed Identity(s) permissions to those resource(s).
    Sku:
      description: The SKU of the Maps Account.
      type: object
      properties:
        name:
          description: The name of the SKU, in standard format (such as S0).
          type: string
          enum:
          - S0
          - S1
          - G2
          x-ms-enum:
            name: name
            modelAsString: true
        tier:
          readOnly: true
          type: string
          description: Gets the sku tier. This is based on the SKU name.
      required:
      - name
    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.
      type: object
      properties:
        primaryKeyLastUpdated:
          type: string
          readOnly: true
          description: The last updated date and time of the primary key.
        primaryKey:
          type: string
          readOnly: true
          description: The primary key for accessing the Maps REST APIs.
        secondaryKey:
          type: string
          readOnly: true
          description: The secondary key for accessing the Maps REST APIs.
        secondaryKeyLastUpdated:
          type: string
          readOnly: true
          description: The last updated date and time of the secondary key.
    MapsAccountSasToken:
      description: A new Sas token which can be used to access the Maps REST APIs and is controlled by the specified Managed identity permissions on Azure (IAM) Role Based Access Control.
      type: object
      properties:
        accountSasToken:
          type: string
          readOnly: true
          description: The shared access signature access token.
    systemData:
      type: object
      description: Metadata pertaining to creation and last modification of the resource.
      properties:
        createdBy:
          type: string
          description: The identity that created the resource.
        createdByType:
          type: string
          description: The type of identity that created the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        createdAt:
          type: string
          format: date-time
          description: The timestamp of resource creation (UTC).
        lastModifiedBy:
          type: string
          description: The identity that last modified the resource.
        lastModifiedByType:
          type: string
          description: The type of identity that last modified the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        lastModifiedAt:
          type: string
          format: date-time
          description: The timestamp of resource last modification (UTC)
      readOnly: true
    CorsRules:
      type: object
      properties:
        corsRules:
          type: array
          maxItems: 5
          items:
            description: Specifies a CORS rule for the Map Account.
            $ref: '#/components/schemas/CorsRule'
          x-ms-identifiers: []
          description: 'The list of CORS rules. You can include up to five CorsRule elements in the request. '
      description: 'Sets the CORS rules. You can include up to five CorsRule elements in the request. '
    MapsAccountUpdateParameters:
      description: Parameters used to update an existing Maps Account.
      type: object
      properties:
        tags:
          type: object
          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.
        kind:
          description: Get or Set Kind property.
          $ref: '#/components/schemas/Kind'
        sku:
          description: The SKU of this account.
          $ref: '#/components/schemas/Sku'
        identity:
          $ref: '#/components/schemas/ManagedServiceIdentity'
        properties:
          description: The map account properties.
          x-ms-client-flatten: true
          $ref: '#/components/schemas/MapsAccountProperties'
    AccountSasParameters:
      description: Parameters used to create an account Shared Access Signature (SAS) token. The REST API access control is provided by Azure Maps Role Based Access (RBAC) identity and access.
      type: object
      properties:
        signingKey:
          type: string
          description: The Map account key to use for signing. Picking `primaryKey` or `secondaryKey` will use the Map account Shared Keys, and using `managedIdentity` will use the auto-renewed private key to sign the SAS.
          enum:
          - primaryKey
          - secondaryKey
          - managedIdentity
          x-ms-enum:
            name: SigningKey
            modelAsString: true
        principalId:
          description: The principal Id also known as the object Id of a User Assigned Managed Identity currently assigned to the Map Account. To assign a Managed Identity of the account, use operation Create or Update an assign a User Assigned Identity resource Id.
          type: string
        regions:
          type: array
          items:
            type: string
          description: 'Optional, allows control of which region locations are permitted access to Azure Maps REST APIs with the SAS token. Example: "eastus", "westus2". Omitting this parameter will allow all region locations to be accessible.'
        maxRatePerSecond:
          type: integer
          maximum: 500
          default: 500
          format: int32
          description: Required parameter which represents the desired maximum request per second to allowed for the given SAS token. This does not guarantee perfect accuracy in measurements but provides application safe guards of abuse with eventual enforcement.
          exclusiveMinimum: 0
        start:
          description: The date time offset of when the token validity begins. For example "2017-05-24T10:42:03.1567373Z". Maximum duration allowed is 24 hours between `start` and `expiry`.
          type: string
        expiry:
          description: The date time offset of when the token validity expires. For example "2017-05-24T10:42:03.1567373Z". Maximum duration allowed is 24 hours between `start` and `expiry`.
          type: string
      required:
      - signingKey
      - principalId
      - maxRatePerSecond
      - start
      - expiry
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group. The name is case insensitive.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    AccountNameParameter:
      name: accountName
      in: path
      description: The name of the Maps Account.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow