Vaults - List

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

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 do URI

Name In Required Type Description
subscriptionId
path True
  • string

Credenciais de subscrição que identificam exclusivamente Microsoft Azure subscrição. O ID de subscrição faz parte do URI para cada chamada de serviço.

$filter
query True

O filtro para aplicar na operação.

api-version
query True

Versão Azure Resource Manager Api.

$top
query
  • integer
int32

Número máximo de resultados para devolver.

Respostas

Name Type Description
200 OK

Obtenha informações sobre todos os cofres chave da assinatura.

Other Status Codes

Resposta de erro descrevendo 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 fornecedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do fornecedor de recursos Key Vault

Resource

Key Vault recurso

ResourceListResult

Lista de recursos do cofre.

ResourceManagerApiVersions

Versão Azure Resource Manager Api.

VaultListFilterTypes

O filtro para aplicar na operação.

CloudError

Uma resposta de erro do fornecedor de recursos Key Vault

Name Type Description
error

Uma resposta de erro do fornecedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do fornecedor de recursos Key Vault

Name Type Description
code
  • string

Código de erro. Este é um mnemónico que pode ser consumido programáticamente.

message
  • string

Mensagem de erro amigável do utilizador. A mensagem é tipicamente localizada e pode variar com a versão de serviço.

Resource

Key Vault recurso

Name Type Description
id
  • string

Identificador totalmente qualificado do recurso do cofre chave.

location
  • string

Localização azul do recurso do cofre chave.

name
  • string

Nome do recurso do cofre chave.

tags
  • object

Etiquetas atribuídas ao recurso do cofre chave.

type
  • string

Tipo de recurso do recurso de cofre chave.

ResourceListResult

Lista de recursos do cofre.

Name Type Description
nextLink
  • string

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

value

A lista de recursos do cofre.

ResourceManagerApiVersions

Versão Azure Resource Manager Api.

Name Type Description
2015-11-01
  • string

VaultListFilterTypes

O filtro para aplicar na operação.

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