Vaults - List

Riferimento

Service:: Key Vault

API Version:: 2022-07-01

L'operazione List ottiene informazioni sugli insiemi di credenziali associati alla sottoscrizione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
$filter	query	True	VaultListFilterTypes	Filtro da applicare all'operazione.
api-version	query	True	ResourceManagerApiVersions	Versione api di Azure Resource Manager.
$top	query		integer int32	Numero massimo di risultati da restituire.

Risposte

Nome	Tipo	Descrizione
200 OK	ResourceListResult	Ottenere informazioni su tutti gli insiemi di credenziali delle chiavi nella sottoscrizione.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

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

Definizioni

Nome	Descrizione
CloudError	Risposta di errore da Key Vault provider di risorse
CloudErrorBody	Risposta di errore da Key Vault provider di risorse
Resource	risorsa Key Vault
ResourceListResult	Elenco di risorse dell'insieme di credenziali.
ResourceManagerApiVersions	Versione api di Azure Resource Manager.
VaultListFilterTypes	Filtro da applicare all'operazione.

CloudError

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore da Key Vault provider di risorse

CloudErrorBody

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore descrittivo. Il messaggio viene in genere localizzato e può variare con la versione del servizio.

Resource

risorsa Key Vault

Nome	Tipo	Descrizione
id	string	Identificatore completo della risorsa dell'insieme di credenziali delle chiavi.
location	string	Posizione di Azure della risorsa dell'insieme di credenziali delle chiavi.
name	string	Nome della risorsa dell'insieme di credenziali delle chiavi.
tags	object	Tag assegnati alla risorsa dell'insieme di credenziali delle chiavi.
type	string	Tipo di risorsa della risorsa dell'insieme di credenziali delle chiavi.

ResourceListResult

Elenco di risorse dell'insieme di credenziali.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set successivo di risorse dell'insieme di credenziali.
value	Resource[]	Elenco di risorse dell'insieme di credenziali.

ResourceManagerApiVersions

Versione api di Azure Resource Manager.

Nome	Tipo	Descrizione
2015-11-01	string

VaultListFilterTypes

Filtro da applicare all'operazione.

Nome	Tipo	Descrizione
resourceType eq 'Microsoft.KeyVault/vaults'	string