Vaults - List

サービス:: Key Vault

API バージョン:: 2024-11-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&api-version=2015-11-01

省略可能なパラメーターを含む:

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


/**
 * Samples for Vaults List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/listVault.json
     */
    /**
     * Sample code: List vaults in the specified subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listVaultsInTheSpecifiedSubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.vaults().manager().serviceClient().getVaults().list(1, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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/2024-11-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

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/listVault.json
func ExampleVaultsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkeyvault.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVaultsClient().NewListPager(&armkeyvault.VaultsClientListOptions{Top: to.Ptr[int32](1)})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ResourceListResult = armkeyvault.ResourceListResult{
		// 	Value: []*armkeyvault.Resource{
		// 		{
		// 			Name: to.Ptr("sample-vault"),
		// 			Type: to.Ptr("Microsoft.KeyVault/vaults"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { KeyVaultManagementClient } = require("@azure/arm-keyvault");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to The List operation gets information about the vaults associated with the subscription.
 *
 * @summary The List operation gets information about the vaults associated with the subscription.
 * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/listVault.json
 */
async function listVaultsInTheSpecifiedSubscription() {
  const subscriptionId =
    process.env["KEYVAULT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const top = 1;
  const options = { top };
  const credential = new DefaultAzureCredential();
  const client = new KeyVaultManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.vaults.list(options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 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

Object

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

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

CloudErrorBody

Object

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

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

Resource

Object

Key Vault リソース

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

ResourceListResult

Object

ボールトリソースのリスト。

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

ResourceManagerApiVersions

列挙

Azure Resource Manager API バージョン。

値	説明
2015-11-01

VaultListFilterTypes

列挙

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

値	説明
resourceType eq 'Microsoft.KeyVault/vaults'

次の方法で共有

Vaults - List

URI パラメーター

応答

例

List vaults in the specified subscription

要求のサンプル

応答のサンプル

定義

CloudError

CloudErrorBody

Resource

ResourceListResult

ResourceManagerApiVersions

VaultListFilterTypes