Vaults - List

Odwołanie

Service:: Key Vault

API Version:: 2022-07-01

Operacja Lista 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

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 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, który ma być stosowany do 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

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

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

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 Vault
ResourceListResult	Lista zasobów magazynu.
ResourceManagerApiVersions	Wersja interfejsu API usługi Azure Resource Manager.
VaultListFilterTypes	Filtr, który ma być stosowany do operacji.

CloudError

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

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

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonic, 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

zasób Key Vault

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

ResourceListResult

Lista zasobów magazynu.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu zasobów magazynu.
value	Resource[]	Lista zasobów magazynu.

ResourceManagerApiVersions

Wersja interfejsu API usługi Azure Resource Manager.

Nazwa	Typ	Opis
2015-11-01	string

VaultListFilterTypes

Filtr, który ma być stosowany do operacji.

Nazwa	Typ	Opis
resourceType eq 'Microsoft.KeyVault/vaults'	string

Share via