Vaults - List

Service:

Key Vault

API Version:

2022-07-01

Der List-Vorgang ruft Informationen zu den Tresoren ab, die dem Abonnement zugeordnet sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
$filter	query	True	VaultListFilterTypes	Der Filter, der auf den Vorgang angewendet werden soll.
api-version	query	True	ResourceManagerApiVersions	Azure Resource Manager API-Version.
$top	query		integer int32	Maximale Anzahl der zurückzugebenden Ergebnisse.

Antworten

Name	Typ	Beschreibung
200 OK	ResourceListResult	Rufen Sie Informationen zu allen Schlüsseltresoren im Abonnement ab.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

List vaults in the specified subscription

Sample Request

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

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

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
Resource	Key Vault-Ressource
ResourceListResult	Liste der Tresorressourcen.
ResourceManagerApiVersions	Azure Resource Manager API-Version.
VaultListFilterTypes	Der Filter, der auf den Vorgang angewendet werden soll.

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

Resource

Key Vault-Ressource

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Schlüsseltresorressource.
location	string	Azure-Speicherort der Schlüsseltresorressource.
name	string	Name der Schlüsseltresorressource.
tags	object	Tags, die der Schlüsseltresorressource zugewiesen sind.
type	string	Ressourcentyp der Schlüsseltresorressource.

ResourceListResult

Liste der Tresorressourcen.

Name	Typ	Beschreibung
nextLink	string	Die URL zum Abrufen der nächsten Gruppe von Tresorressourcen.
value	Resource[]	Die Liste der Tresorressourcen.

ResourceManagerApiVersions

Azure Resource Manager API-Version.

Name	Typ	Beschreibung
2015-11-01	string

VaultListFilterTypes

Der Filter, der auf den Vorgang angewendet werden soll.

Name	Typ	Beschreibung
resourceType eq 'Microsoft.KeyVault/vaults'	string