Vaults - List

Serviço:

Key Vault

Versão da API:

2022-07-01

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=2015-11-01

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
$filter	query	True	VaultListFilterTypes	O filtro a ser aplicado na operação.
api-version	query	True	ResourceManagerApiVersions	Versão da API do Azure Resource Manager.
$top	query		integer (int32)	Número máximo de resultados a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	ResourceListResult	Obtenha informações sobre todos os cofres de chaves na assinatura.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Exemplos

List vaults in the specified subscription

Solicitação de exemplo

HTTP

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python list_vault.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.vaults.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listVault.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

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

Nome	Description
CloudError	Uma resposta de erro do provedor de recursos do Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos do Key Vault
Resource	Recurso do Key Vault
ResourceListResult	Lista de recursos do cofre.
ResourceManagerApiVersions	Versão da API do Azure Resource Manager.
VaultListFilterTypes	O filtro a ser aplicado na operação.

CloudError

Objeto

Uma resposta de erro do provedor de recursos do Key Vault

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do provedor de recursos do Key Vault

CloudErrorBody

Objeto

Uma resposta de erro do provedor de recursos do Key Vault

Nome	Tipo	Description
code	string	Código de erro. Este é um mnemônico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável. A mensagem normalmente é localizada e pode variar com a versão do serviço.

Resource

Objeto

Recurso do Key Vault

Nome	Tipo	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

Objeto

Lista de recursos do cofre.

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de recursos do cofre.
value	Resource[]	A lista de recursos do cofre.

ResourceManagerApiVersions

Enumeração

Versão da API do Azure Resource Manager.

Valor	Description
2015-11-01

VaultListFilterTypes

Enumeração

O filtro a ser aplicado na operação.

Valor	Description
resourceType eq 'Microsoft.KeyVault/vaults'