Vaults - List

A operação Lista obtém informações sobre os cofres associados à assinatura.

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

Parâmetros de URI

Name In Required Type Description
subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

$filter
query True

O filtro a ser aplicado na operação.

api-version
query True

Versão da API Resource Manager do Azure.

$top
query
  • integer
int32

Número máximo de resultados a serem retornados.

Respostas

Name Type Description
200 OK

Obtenha informações sobre todos os cofres de chaves na assinatura.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Exemplos

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=2021-10-01

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"
}

Definições

CloudError

Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Resource

Recurso do Key Vault

ResourceListResult

Lista de recursos do cofre.

ResourceManagerApiVersions

Versão da API Resource Manager do Azure.

VaultListFilterTypes

O filtro a ser aplicado na operação.

CloudError

Uma resposta de erro do provedor de recursos Key Vault

Name Type Description
error

Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Name Type Description
code
  • string

Código do erro. Este é um mnemônico que pode ser consumido programaticamente.

message
  • string

Mensagem de erro amigável. Normalmente, a mensagem é localizada e pode variar com a versão de serviço.

Resource

Recurso do Key Vault

Name Type Description
id
  • string

Identificador totalmente qualificado do recurso do cofre de chaves.

location
  • string

Local do Azure do recurso do cofre de chaves.

name
  • string

Nome do recurso do cofre de chaves.

tags
  • object

Marcas atribuídas ao recurso do cofre de chaves.

type
  • string

Tipo de recurso do recurso do cofre de chaves.

ResourceListResult

Lista de recursos do cofre.

Name Type Description
nextLink
  • string

A URL para obter o próximo conjunto de recursos do cofre.

value

A lista de recursos do cofre.

ResourceManagerApiVersions

Versão da API Resource Manager do Azure.

Name Type Description
2015-11-01
  • string

VaultListFilterTypes

O filtro a ser aplicado na operação.

Name Type Description
resourceType eq 'Microsoft.KeyVault/vaults'
  • string