Azure Key Vault Subscriptions API

The Subscriptions API from Azure Key Vault — 5 operation(s) for subscriptions.

GitHub OpenAPI

Operations 5

POST /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkMhsmNameAvailability Managed hsms check mhsm name availability #
POST /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability Vaults check name availability #
GET /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedManagedHSMs Managed hsms list deleted #
GET /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedVaults Vaults list deleted #
GET /subscriptions/{subscriptionId}/resources Vaults list #

Documentation

Specifications

Schemas & Data

Other Resources

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-key-vault:microsoft-azure-key-vault-subscriptions-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-key-vault-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: KeyVaultManagementClient Subscriptions API
  version: '2026-05-15'
  description: The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Subscriptions
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkMhsmNameAvailability:
    post:
      operationId: ManagedHsms_CheckMhsmNameAvailability
      description: Checks that the managed hsm name is valid and is not already in use.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckMhsmNameAvailabilityResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckMhsmNameAvailabilityParameters'
        description: The request body
        required: true
      tags:
      - Subscriptions
      summary: Managed hsms check mhsm name availability
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability:
    post:
      operationId: Vaults_CheckNameAvailability
      description: Checks that the vault name is valid and is not already in use.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckNameAvailabilityResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VaultCheckNameAvailabilityParameters'
        description: The name of the vault.
        required: true
      tags:
      - Subscriptions
      summary: Vaults check name availability
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedManagedHSMs:
    get:
      operationId: ManagedHsms_ListDeleted
      description: The List operation gets information about the deleted managed HSMs associated with the subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedManagedHsmListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedHsmError'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
      summary: Managed hsms list deleted
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/deletedVaults:
    get:
      operationId: Vaults_ListDeleted
      description: Gets information about the deleted vaults in a subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedVaultListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
      summary: Vaults list deleted
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resources:
    get:
      operationId: Vaults_List
      description: The List operation gets information about the vaults associated with the subscription.
      parameters:
      - name: $filter
        in: query
        description: The filter to apply on the operation.
        required: true
        x-ms-enum:
          modelAsString: false
        schema:
          type: string
          enum:
          - resourceType eq 'Microsoft.KeyVault/vaults'
      - name: $top
        in: query
        description: Maximum number of results to return.
        required: false
        schema:
          type: integer
          format: int32
      - name: api-version
        in: query
        description: Azure Resource Manager Api Version.
        required: true
        x-ms-enum:
          modelAsString: false
        x-ms-api-version: false
        schema:
          type: string
          enum:
          - '2015-11-01'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
      summary: Vaults list
      x-summary-source: derived
components:
  schemas:
    CheckMhsmNameAvailabilityResult:
      type: object
      description: The CheckMhsmNameAvailability operation response.
      properties:
        nameAvailable:
          type: boolean
          description: A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
          readOnly: true
        reason:
          $ref: '#/components/schemas/Reason'
          description: The reason that a managed hsm name could not be used. The reason element is only returned if NameAvailable is false.
          readOnly: true
        message:
          type: string
          description: An error message explaining the Reason value in more detail.
          readOnly: true
    ResourceListResult:
      type: object
      description: The list of vault resources.
      properties:
        value:
          type: array
          description: The list of vault resources.
          items:
            $ref: '#/components/schemas/TrackedResource'
        nextLink:
          type: string
          format: uri
          description: The URL to get the next set of vault resources.
      required:
      - value
    VaultCheckNameAvailabilityParameters:
      type: object
      description: The parameters used to check the availability of the vault name.
      properties:
        name:
          type: string
          description: The vault name.
        type:
          type: string
          description: The type of resource, Microsoft.KeyVault/vaults
          enum:
          - Microsoft.KeyVault/vaults
          x-ms-enum:
            modelAsString: false
      required:
      - name
      - type
    CloudError:
      type: object
      description: An error response from Key Vault resource provider
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: An error response from Key Vault resource provider
      x-ms-external: true
    DeletedManagedHsmListResult:
      type: object
      description: The response of a DeletedManagedHsm list operation.
      properties:
        value:
          type: array
          description: The DeletedManagedHsm items on this page
          items:
            $ref: '#/components/schemas/DeletedManagedHsm'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    CheckNameAvailabilityResult:
      type: object
      description: The CheckNameAvailability operation response.
      properties:
        nameAvailable:
          type: boolean
          description: A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
          readOnly: true
        reason:
          $ref: '#/components/schemas/Reason'
          description: The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
          readOnly: true
        message:
          type: string
          description: An error message explaining the Reason value in more detail.
          readOnly: true
    DeletedManagedHsmProperties:
      type: object
      description: Properties of the deleted managed HSM.
      properties:
        mhsmId:
          type: string
          description: The resource id of the original managed HSM.
          readOnly: true
        location:
          type: string
          description: The location of the original managed HSM.
          readOnly: true
        deletionDate:
          type: string
          format: date-time
          description: The deleted date.
          readOnly: true
        scheduledPurgeDate:
          type: string
          format: date-time
          description: The scheduled purged date.
          readOnly: true
        purgeProtectionEnabled:
          type: boolean
          description: Purge protection status of the original managed HSM.
          readOnly: true
        tags:
          type: object
          description: Tags of the original managed HSM.
          additionalProperties:
            type: string
          readOnly: true
    DeletedManagedHsm:
      type: object
      description: Concrete proxy resource types can be created by aliasing this type using a specific property type.
      properties:
        properties:
          $ref: '#/components/schemas/DeletedManagedHsmProperties'
          description: Properties of the deleted managed HSM
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    Reason:
      type: string
      description: The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
      enum:
      - AccountNameInvalid
      - AlreadyExists
      x-ms-enum:
        name: Reason
        modelAsString: true
        values:
        - name: AccountNameInvalid
          value: AccountNameInvalid
        - name: AlreadyExists
          value: AlreadyExists
    DeletedVault:
      type: object
      description: Deleted vault information with extended details.
      properties:
        properties:
          $ref: '#/components/schemas/DeletedVaultProperties'
          description: Properties of the vault
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    Error:
      type: object
      description: The server error.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        innererror:
          $ref: '#/components/schemas/Error'
          description: The inner error, contains a more specific error code.
          readOnly: true
          x-ms-client-name: innerError
    DeletedVaultProperties:
      type: object
      description: Properties of the deleted vault.
      properties:
        vaultId:
          type: string
          description: The resource id of the original vault.
          readOnly: true
        location:
          type: string
          description: The location of the original vault.
          readOnly: true
        deletionDate:
          type: string
          format: date-time
          description: The deleted date.
          readOnly: true
        scheduledPurgeDate:
          type: string
          format: date-time
          description: The scheduled purged date.
          readOnly: true
        tags:
          type: object
          description: Tags of the original vault.
          additionalProperties:
            type: string
          readOnly: true
        purgeProtectionEnabled:
          type: boolean
          description: Purge protection status of the original vault.
          readOnly: true
    DeletedVaultListResult:
      type: object
      description: The response of a DeletedVault list operation.
      properties:
        value:
          type: array
          description: The DeletedVault items on this page
          items:
            $ref: '#/components/schemas/DeletedVault'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    TrackedResource:
      type: object
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
    CheckMhsmNameAvailabilityParameters:
      type: object
      description: The parameters used to check the availability of the managed hsm name.
      properties:
        name:
          type: string
          description: The managed hsm name.
      required:
      - name
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    CloudErrorBody:
      type: object
      description: An error response from Key Vault resource provider
      properties:
        code:
          type: string
          description: Error code. This is a mnemonic that can be consumed programmatically.
        message:
          type: string
          description: User friendly error message. The message is typically localized and may vary with service version.
      x-ms-external: true
    ManagedHsmError:
      type: object
      description: The error exception.
      properties:
        error:
          $ref: '#/components/schemas/Error'
          description: The server error.
          readOnly: true
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      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.