Vaults - List

Služba:

Key Vault

Verze rozhraní API:

2024-11-01

Operace List získá informace o trezorech přidružených k předplatnému.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
$filter	query	True	VaultListFilterTypes	Filtr, který se má použít pro operaci.
api-version	query	True	ResourceManagerApiVersions	Verze rozhraní API služby Azure Resource Manager.
$top	query		integer (int32)	Maximální počet výsledků, které se mají vrátit.

Odpovědi

Name	Typ	Description
200 OK	ResourceListResult	Získejte informace o všech trezorech klíčů v předplatném.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Příklady

List vaults in the specified subscription

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
Resource	Prostředek služby Key Vault
ResourceListResult	Seznam prostředků úschovny.
ResourceManagerApiVersions	Verze rozhraní API služby Azure Resource Manager.
VaultListFilterTypes	Filtr, který se má použít pro operaci.

CloudError

Objekt

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault

CloudErrorBody

Objekt

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
code	string	Kód chyby Jedná se o mnemotechnickou pomůcku, kterou lze programově využívat.
message	string	Uživatelsky přívětivá chybová hláška. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

Resource

Objekt

Prostředek služby Key Vault

Name	Typ	Description
id	string	Plně kvalifikovaný identifikátor prostředku trezoru klíčů.
location	string	Umístění prostředku trezoru klíčů v Azure.
name	string	Název prostředku trezoru klíčů.
tags	object	Značky přiřazené k prostředku trezoru klíčů.
type	string	Typ prostředku trezoru klíčů.

ResourceListResult

Objekt

Seznam prostředků úschovny.

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady prostředků úschovny.
value	Resource[]	Seznam prostředků úschovny.

ResourceManagerApiVersions

Výčet

Verze rozhraní API služby Azure Resource Manager.

Hodnota	Description
2015-11-01

VaultListFilterTypes

Výčet

Filtr, který se má použít pro operaci.

Hodnota	Description
resourceType eq 'Microsoft.KeyVault/vaults'