Vaults - List

Usługa:

Key Vault

Wersja interfejsu API:

2024-11-01

Operacja List pobiera informacje o magazynach skojarzonych z subskrypcją.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
$filter	query	True	VaultListFilterTypes	Filtr do zastosowania w operacji.
api-version	query	True	ResourceManagerApiVersions	Wersja interfejsu API usługi Azure Resource Manager.
$top	query		integer (int32)	Maksymalna liczba wyników do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ResourceListResult	Uzyskaj informacje o wszystkich magazynach kluczy w subskrypcji.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

List vaults in the specified subscription

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
CloudError	Odpowiedź o błędzie od dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault
Resource	Zasób Key VaultKey Vault resource
ResourceListResult	Lista zasobów magazynu.
ResourceManagerApiVersions	Wersja interfejsu API usługi Azure Resource Manager.
VaultListFilterTypes	Filtr do zastosowania w operacji.

CloudError

Objekt

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault

CloudErrorBody

Objekt

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonik, który może być używany programowo.
message	string	Przyjazny dla użytkownika komunikat o błędzie. Komunikat jest zazwyczaj zlokalizowany i może się różnić w zależności od wersji usługi.

Resource

Objekt

Zasób Key VaultKey Vault resource

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu magazynu kluczy.
location	string	Lokalizacja zasobu magazynu kluczy na platformie Azure.
name	string	Nazwa zasobu magazynu kluczy.
tags	object	Tagi przypisane do zasobu magazynu kluczy.
type	string	Typ zasobu magazynu kluczy.

ResourceListResult

Objekt

Lista zasobów magazynu.

Nazwa	Typ	Opis
nextLink	string	Adres URL, aby uzyskać następny zestaw zasobów magazynu.
value	Resource[]	Lista zasobów repozytorium.

ResourceManagerApiVersions

Wyliczenie

Wersja interfejsu API usługi Azure Resource Manager.

Wartość	Opis
2015-11-01

VaultListFilterTypes

Wyliczenie

Filtr do zastosowania w operacji.

Wartość	Opis
resourceType eq 'Microsoft.KeyVault/vaults'