Vaults - List

Referencia

Service:: Key Vault

API Version:: 2022-07-01

La operación List obtiene información sobre los almacenes asociados a la suscripción.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
$filter	query	True	VaultListFilterTypes	Filtro que se va a aplicar en la operación.
api-version	query	True	ResourceManagerApiVersions	Versión de api de Azure Resource Manager.
$top	query		integer int32	El número máximo de resultados que se devolverán.

Respuestas

Nombre	Tipo	Description
200 OK	ResourceListResult	Obtenga información sobre todos los almacenes de claves de la suscripción.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Ejemplos

List vaults in the specified subscription

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

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

Sample Response

Status code:: 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"
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del proveedor de recursos de Key Vault
CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault
Resource	Recurso de Key Vault
ResourceListResult	Lista de recursos del almacén.
ResourceManagerApiVersions	Versión de api de Azure Resource Manager.
VaultListFilterTypes	Filtro que se va a aplicar en la operación.

CloudError

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
code	string	Código de error. Se trata de una mnemónica que se puede consumir mediante programación.
message	string	Mensaje de error descriptivo. El mensaje suele localizarse y puede variar con la versión del servicio.

Resource

Recurso de Key Vault

Nombre	Tipo	Description
id	string	Identificador completo del recurso del almacén de claves.
location	string	Ubicación de Azure del recurso del almacén de claves.
name	string	Nombre del recurso del almacén de claves.
tags	object	Etiquetas asignadas al recurso del almacén de claves.
type	string	Tipo de recurso del recurso del almacén de claves.

ResourceListResult

Lista de recursos del almacén.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de recursos del almacén.
value	Resource[]	Lista de recursos del almacén.

ResourceManagerApiVersions

Versión de api de Azure Resource Manager.

Nombre	Tipo	Description
2015-11-01	string

VaultListFilterTypes

Filtro que se va a aplicar en la operación.

Nombre	Tipo	Description
resourceType eq 'Microsoft.KeyVault/vaults'	string