Vaults - List

The List operation gets information about the vaults associated with the subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&api-version=2018-02-14
GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top={$top}&api-version=2018-02-14

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

$filter
query True
  • string

The filter to apply on the operation.

$top
query
  • integer
int32

Maximum number of results to return.

api-version
query True
  • string

Azure Resource Manager Api Version.

Responses

Name Type Description
200 OK

Get information about all key vaults in the subscription.

Examples

List vaults in the specified subscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top=1&api-version=2018-02-14

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault",
      "name": "sample-vault",
      "type": "Microsoft.KeyVault/vaults",
      "location": "westus",
      "tags": {}
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?%24filter=resourceType+eq+%27Microsoft.KeyVault%2fvaults%27&%24top=4&api-version=2015-11-01&%24skiptoken=eyJuZXh0UGFydGl0aW9uS2V5IjoiMSE4IVEwTTJNVGMtIiwibmV4dFJvd0tleSI6IjEhMTMyIU5rUTRSVEU1UXpJelFUWXdORGd4UmpoRlFrSXhNVGhFUXpNd01EZEROVVJmVkVkT1RDMU5TVU5TVDFOUFJsUTZNa1ZMUlZsV1FWVk1WRG95UmxaQlZVeFVVeTFUVTFKSExVcEpUVG95UkZSRlUxUTZNa1JXUVZWTVZDMVhSVk5VVlZNLSJ9"
}

Definitions

Resource

Key Vault resource

ResourceListResult

List of vault resources.

Resource

Key Vault resource

Name Type Description
id
  • string

The Azure Resource Manager resource ID for the key vault.

location
  • string

The supported Azure location where the key vault should be created.

name
  • string

The name of the key vault.

tags
  • object

The tags that will be assigned to the key vault.

type
  • string

The resource type of the key vault.

ResourceListResult

List of vault resources.

Name Type Description
nextLink
  • string

The URL to get the next set of vault resources.

value

The list of vault resources.