Vaults - List

Dienst:

Key Vault

API-Version:

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

Mit optionalen Parametern:

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	Version der Azure Resource Manager-API.
$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, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

List vaults in the specified subscription

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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 vom Key Vault-Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort vom Key Vault-Ressourcenanbieter
Resource	Key Vault-Ressource
ResourceListResult	Liste der Tresorressourcen.
ResourceManagerApiVersions	Version der Azure Resource Manager-API.
VaultListFilterTypes	Der filter, der auf den Vorgang angewendet werden soll.

CloudError

Objekt

Eine Fehlerantwort vom Key Vault-Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort vom Key Vault-Ressourcenanbieter

CloudErrorBody

Objekt

Eine Fehlerantwort vom Key Vault-Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode. Dabei handelt es sich um eine Eselsbrücke, die programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Meldung ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

Resource

Objekt

Key Vault-Ressource

Name	Typ	Beschreibung
id	string	Vollqualifizierter Bezeichner der Key Vault-Ressource.
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

Objekt

Liste der Tresorressourcen.

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

ResourceManagerApiVersions

Enumeration

Version der Azure Resource Manager-API.

Wert	Beschreibung
2015-11-01

VaultListFilterTypes

Enumeration

Der filter, der auf den Vorgang angewendet werden soll.

Wert	Beschreibung
resourceType eq 'Microsoft.KeyVault/vaults'