Vaults - List

リファレンス

Service:: Key Vault

API Version:: 2022-07-01

List 操作は、サブスクリプションに関連付けられているコンテナーに関する情報を取得します。

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 パラメーター

名前	/	必須	型	説明
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	返される結果の最大数。

応答

名前	型	説明
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"
}

定義

名前	説明
CloudError	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
Resource	Key Vault リソース
ResourceListResult	コンテナーリソースの一覧。
ResourceManagerApiVersions	Azure Resource Manager Api バージョン。
VaultListFilterTypes	操作に適用するフィルター。

CloudError

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
error	CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault

CloudErrorBody

リソースプロバイダーからのエラー応答Key Vault

名前	型	説明
code	string	エラーコード。これは、プログラムで使用できるニーモニックです。
message	string	わかりやすいエラーメッセージ。通常、メッセージはローカライズされており、サービスのバージョンによって異なる場合があります。

Resource

Key Vault リソース

名前	型	説明
id	string	キーコンテナーリソースの完全修飾識別子。
location	string	キーコンテナーリソースの Azure の場所。
name	string	キーコンテナーリソースの名前。
tags	object	キーコンテナーリソースに割り当てられたタグ。
type	string	キーコンテナーリソースのリソースの種類。

ResourceListResult

コンテナーリソースの一覧。

名前	型	説明
nextLink	string	コンテナーリソースの次のセットを取得する URL。
value	Resource[]	コンテナーリソースの一覧。

ResourceManagerApiVersions

Azure Resource Manager Api バージョン。

名前	型	説明
2015-11-01	string

VaultListFilterTypes

操作に適用するフィルター。

名前	型	説明
resourceType eq 'Microsoft.KeyVault/vaults'	string