Vaults - List

Service:

Key Vault

API Version:

2022-07-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

With optional parameters:

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 je součástí identifikátoru URI pro každé volání služby.
$filter	query	True	VaultListFilterTypes	Filtr, který se má použít na operaci.
api-version	query	True	ResourceManagerApiVersions	Verze rozhraní API azure Resource Manager.
$top	query		integer int32	Maximální počet vrácených výsledků

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

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

Definice

Name	Description
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
Resource	Key Vault prostředek
ResourceListResult	Seznam prostředků trezoru
ResourceManagerApiVersions	Verze rozhraní API azure Resource Manager.
VaultListFilterTypes	Filtr, který se má použít na operaci.

CloudError

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

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

CloudErrorBody

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

Name	Typ	Description
code	string	Kód chyby Jedná se o mnemotechnický objekt, který je možné využívat programově.
message	string	Uživatelsky přívětivá chybová zpráva. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

Resource

Key Vault prostředek

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

Seznam prostředků trezoru

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

ResourceManagerApiVersions

Verze rozhraní API azure Resource Manager.

Name	Typ	Description
2015-11-01	string

VaultListFilterTypes

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

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