Vaults - List

참조

Service:: Key Vault

API Version:: 2022-07-01

목록 작업은 구독과 연결된 자격 증명 모음에 대한 정보를 가져옵니다.

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 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
$filter	query	True	VaultListFilterTypes	작업에 적용할 필터입니다.
api-version	query	True	ResourceManagerApiVersions	Azure Resource Manager API 버전.
$top	query		integer int32	반환할 최대 결과 수입니다.

응답

Name	형식	Description
200 OK	ResourceListResult	구독의 모든 키 자격 증명 모음에 대한 정보를 가져옵니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

예제

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

정의

Name	Description
CloudError	Key Vault 리소스 공급자의 오류 응답
CloudErrorBody	Key Vault 리소스 공급자의 오류 응답
Resource	키 자격 증명 모음 리소스
ResourceListResult	자격 증명 모음 리소스 목록입니다.
ResourceManagerApiVersions	Azure Resource Manager API 버전.
VaultListFilterTypes	작업에 적용할 필터입니다.

CloudError

Key Vault 리소스 공급자의 오류 응답

Name	형식	Description
error	CloudErrorBody	Key Vault 리소스 공급자의 오류 응답

CloudErrorBody

Key Vault 리소스 공급자의 오류 응답

Name	형식	Description
code	string	오류 코드 프로그래밍 방식으로 사용할 수 있는 니모닉입니다.
message	string	사용자에게 친숙한 오류 메시지입니다. 메시지는 일반적으로 지역화되며 서비스 버전에 따라 다를 수 있습니다.

Resource

키 자격 증명 모음 리소스

Name	형식	Description
id	string	키 자격 증명 모음 리소스의 정규화된 식별자입니다.
location	string	키 자격 증명 모음 리소스의 Azure 위치입니다.
name	string	키 자격 증명 모음 리소스의 이름입니다.
tags	object	키 자격 증명 모음 리소스에 할당된 태그입니다.
type	string	키 자격 증명 모음 리소스의 리소스 종류입니다.

ResourceListResult

자격 증명 모음 리소스 목록입니다.

Name	형식	Description
nextLink	string	다음 자격 증명 모음 리소스 집합을 가져올 URL입니다.
value	Resource[]	자격 증명 모음 리소스 목록입니다.

ResourceManagerApiVersions

Azure Resource Manager API 버전.

Name	형식	Description
2015-11-01	string

VaultListFilterTypes

작업에 적용할 필터입니다.

Name	형식	Description
resourceType eq 'Microsoft.KeyVault/vaults'	string