Vaults - List

Servicio:

Key Vault

Versión de la API:

2024-11-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

Con parámetros opcionales:

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 de cada llamada de servicio.
$filter	query	True	VaultListFilterTypes	Filtro que se va a aplicar en la operación.
api-version	query	True	ResourceManagerApiVersions	Versión de la API de Azure Resource Manager.
$top	query		integer (int32)	Número máximo de resultados que se van a devolver.

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 por qué se produjo un error en la operación.

Ejemplos

List vaults in the specified subscription

Solicitud de ejemplo

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

Respuesta de muestra

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	Una respuesta de error del proveedor de recursos de Key Vault
CloudErrorBody	Una 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 la API de Azure Resource Manager.
VaultListFilterTypes	Filtro que se va a aplicar en la operación.

CloudError

Objeto

Una respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
error	CloudErrorBody	Una respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Objeto

Una respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
code	string	Código de error. Se trata de una mnemotecnia que se puede consumir mediante programación.
message	string	Mensaje de error fácil de usar. El mensaje suele estar localizado y puede variar según la versión del servicio.

Resource

Objeto

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 de 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

Objeto

Lista de recursos del almacén.

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

ResourceManagerApiVersions

Enumeración

Versión de la API de Azure Resource Manager.

Valor	Description
2015-11-01

VaultListFilterTypes

Enumeración

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

Valor	Description
resourceType eq 'Microsoft.KeyVault/vaults'