Vaults - List

Başvuru

Service:: Key Vault

API Version:: 2022-07-01

List işlemi, abonelikle ilişkili kasalar hakkında bilgi alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
$filter	query	True	VaultListFilterTypes	İşlemde uygulanacak filtre.
api-version	query	True	ResourceManagerApiVersions	Azure Resource Manager Api Sürümü.
$top	query		integer int32	Döndürülecek en fazla sonuç sayısı.

Yanıtlar

Name	Tür	Description
200 OK	ResourceListResult	Abonelikteki tüm anahtar kasaları hakkında bilgi edinin.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

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

Tanımlar

Name	Description
CloudError	Key Vault kaynak sağlayıcısından hata yanıtı
CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı
Resource	Key Vault kaynağı
ResourceListResult	Kasa kaynaklarının listesi.
ResourceManagerApiVersions	Azure Resource Manager Api Sürümü.
VaultListFilterTypes	İşlemde uygulanacak filtre.

CloudError

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
error	CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı

CloudErrorBody

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
code	string	Hata kodu. Bu, program aracılığıyla kullanılabilecek bir anımsatıcıdır.
message	string	Kullanıcı dostu hata iletisi. İleti genellikle yerelleştirilir ve hizmet sürümüne göre farklılık gösterebilir.

Resource

Key Vault kaynağı

Name	Tür	Description
id	string	Anahtar kasası kaynağının tam tanımlayıcısı.
location	string	Anahtar kasası kaynağının Azure konumu.
name	string	Anahtar kasası kaynağının adı.
tags	object	Anahtar kasası kaynağına atanan etiketler.
type	string	Anahtar kasası kaynağının kaynak türü.

ResourceListResult

Kasa kaynaklarının listesi.

Name	Tür	Description
nextLink	string	Sonraki kasa kaynakları kümesini almak için URL.
value	Resource[]	Kasa kaynaklarının listesi.

ResourceManagerApiVersions

Azure Resource Manager Api Sürümü.

Name	Tür	Description
2015-11-01	string

VaultListFilterTypes

İşlemde uygulanacak filtre.

Name	Tür	Description
resourceType eq 'Microsoft.KeyVault/vaults'	string