Vaults - List By Subscription

リファレンス

サービス:: Key Vault

API バージョン:: 2022-07-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?api-version=2022-07-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2022-07-01

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。
$top	query		integer int32	返される結果の最大数。

応答

名前	型	説明
200 OK	VaultListResult	指定したサブスクリプション内のすべてのキーコンテナーに関する情報を取得します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

例

List vaults in the specified subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/vaults?$top=1&api-version=2022-07-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_by_subscription.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_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listVaultBySubscription.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

応答のサンプル

状態コード:: 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": {},
      "systemData": {
        "createdBy": "keyVaultUser1",
        "createdByType": "User",
        "createdAt": "2020-01-01T12:00:00.0000000Z",
        "lastModifiedBy": "keyVaultUser2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
      },
      "properties": {
        "sku": {
          "family": "A",
          "name": "premium"
        },
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "accessPolicies": [
          {
            "tenantId": "00000000-0000-0000-0000-000000000000",
            "objectId": "00000000-0000-0000-0000-000000000000",
            "permissions": {
              "keys": [
                "encrypt",
                "decrypt",
                "wrapKey",
                "unwrapKey",
                "sign",
                "verify",
                "get",
                "list",
                "create",
                "update",
                "import",
                "delete",
                "backup",
                "restore",
                "recover",
                "purge"
              ],
              "secrets": [
                "get",
                "list",
                "set",
                "delete",
                "backup",
                "restore",
                "recover",
                "purge"
              ],
              "certificates": [
                "get",
                "list",
                "delete",
                "create",
                "import",
                "update",
                "managecontacts",
                "getissuers",
                "listissuers",
                "setissuers",
                "deleteissuers",
                "manageissuers",
                "recover",
                "purge"
              ]
            }
          }
        ],
        "enabledForDeployment": true,
        "enabledForDiskEncryption": true,
        "enabledForTemplateDeployment": true,
        "enableSoftDelete": true,
        "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
        "vaultUri": "https://sample-vault.vault.azure.net/",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?api-version=22022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

定義

名前	説明
AccessPolicyEntry	キーコンテナーにアクセスできる ID。配列内のすべての ID は、キーコンテナーのテナント ID と同じテナント ID を使用する必要があります。
ActionsRequired	サービスプロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。
CertificatePermissions	証明書に対するアクセス許可
CloudError	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
CreateMode	コンテナーを復旧する必要があるかどうかを示すコンテナーの作成モード。
identityType	キーコンテナーリソースを作成した ID の種類。
IPRule	特定の IP アドレスまたは IP 範囲からのコンテナーのアクセシビリティを制御する規則。
KeyPermissions	キーに対するアクセス許可
NetworkRuleAction	ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。これは、バイパスプロパティが評価された後にのみ使用されます。
NetworkRuleBypassOptions	ネットワークルールをバイパスできるトラフィックを指定します。これは、"AzureServices" または "None" にすることができます。指定しない場合、既定値は 'AzureServices' です。
NetworkRuleSet	コンテナーのネットワークアクセシビリティを制御する一連の規則。
Permissions	キー、シークレット、証明書、ストレージに対する ID のアクセス許可。
PrivateEndpoint	プライベートエンドポイントオブジェクトのプロパティ。
PrivateEndpointConnectionItem	プライベートエンドポイント接続項目。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionState	プライベートリンク接続の承認状態を表すオブジェクト。
SecretPermissions	シークレットへのアクセス許可
Sku	SKU の詳細
SkuFamily	SKU ファミリ名
SkuName	キーコンテナーが Standard コンテナーか Premium コンテナーかを指定する SKU 名。
StoragePermissions	ストレージアカウントへのアクセス許可
SystemData	キーコンテナーリソースの作成と最後の変更に関連するメタデータ。
Vault	拡張された詳細を含むリソース情報。
VaultListResult	コンテナーの一覧
VaultProperties	コンテナーのプロパティ
VaultProvisioningState	コンテナーのプロビジョニング状態。
VirtualNetworkRule	特定の仮想ネットワークからのコンテナーのアクセシビリティを制御するルール。

AccessPolicyEntry

キーコンテナーにアクセスできる ID。配列内のすべての ID は、キーコンテナーのテナント ID と同じテナント ID を使用する必要があります。

名前	型	説明
applicationId	string	プリンシパルに代わって要求を行うクライアントのアプリケーション ID
objectId	string	コンテナーの Azure Active Directory テナント内のユーザー、サービスプリンシパル、またはセキュリティグループのオブジェクト ID。オブジェクト ID は、アクセスポリシーの一覧に関して一意である必要があります。
permissions	Permissions	ID がキー、シークレット、証明書に対して持つアクセス許可。
tenantId	string	キーコンテナーへの要求を認証するために使用する必要がある Azure Active Directory テナント ID。

ActionsRequired

サービスプロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。

名前	型	説明
None	string

CertificatePermissions

証明書に対するアクセス許可

名前	型	説明
all	string
backup	string
create	string
delete	string
deleteissuers	string
get	string
getissuers	string
import	string
list	string
listissuers	string
managecontacts	string
manageissuers	string
purge	string
recover	string
restore	string
setissuers	string
update	string

CloudError

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

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

CloudErrorBody

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

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

CreateMode

コンテナーを復旧する必要があるかどうかを示すコンテナーの作成モード。

名前	型	説明
default	string
recover	string

identityType

キーコンテナーリソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

特定の IP アドレスまたは IP 範囲からのコンテナーのアクセシビリティを制御する規則。

名前	型	説明
value	string	CIDR 表記の IPv4 アドレス範囲 ('124.56.78.91' (単純 IP アドレス) または '124.56.78.0/24' (124.56.78 で始まるすべてのアドレス) など)。

KeyPermissions

キーに対するアクセス許可

名前	型	説明
all	string
backup	string
create	string
decrypt	string
delete	string
encrypt	string
get	string
getrotationpolicy	string
import	string
list	string
purge	string
recover	string
release	string
restore	string
rotate	string
setrotationpolicy	string
sign	string
unwrapKey	string
update	string
verify	string
wrapKey	string

NetworkRuleAction

ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。これは、バイパスプロパティが評価された後にのみ使用されます。

名前	型	説明
Allow	string
Deny	string

NetworkRuleBypassOptions

ネットワークルールをバイパスできるトラフィックを指定します。これは、"AzureServices" または "None" にすることができます。指定しない場合、既定値は 'AzureServices' です。

名前	型	説明
AzureServices	string
None	string

NetworkRuleSet

コンテナーのネットワークアクセシビリティを制御する一連の規則。

名前	型	説明
bypass	NetworkRuleBypassOptions	ネットワークルールをバイパスできるトラフィックを指定します。これは、"AzureServices" または "None" にすることができます。指定しない場合、既定値は 'AzureServices' です。
defaultAction	NetworkRuleAction	ipRules と virtualNetworkRules のルールが一致しない場合の既定のアクション。これは、バイパスプロパティが評価された後にのみ使用されます。
ipRules	IPRule[]	IP アドレス規則の一覧。
virtualNetworkRules	VirtualNetworkRule[]	仮想ネットワーク規則の一覧。

Permissions

キー、シークレット、証明書、ストレージに対する ID のアクセス許可。

名前	型	説明
certificates	CertificatePermissions[]	証明書に対するアクセス許可
keys	KeyPermissions[]	キーに対するアクセス許可
secrets	SecretPermissions[]	シークレットへのアクセス許可
storage	StoragePermissions[]	ストレージアカウントに対するアクセス許可

PrivateEndpoint

プライベートエンドポイントオブジェクトのプロパティ。

名前	型	説明
id	string	プライベートエンドポイントリソースの完全識別子。

PrivateEndpointConnectionItem

プライベートエンドポイント接続項目。

名前	型	説明
etag	string	プライベートエンドポイント接続の状態が変更されるたびに変更されます。
id	string	プライベートエンドポイント接続の ID。
properties.privateEndpoint	PrivateEndpoint	プライベートエンドポイントオブジェクトのプロパティ。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベートリンク接続の承認状態。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。

PrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。

名前	型	説明
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

プライベートエンドポイント接続の状態。

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

プライベートリンク接続の承認状態を表すオブジェクト。

名前	型	説明
actionsRequired	ActionsRequired	サービスプロバイダーの変更にコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	承認または却下の理由。
status	PrivateEndpointServiceConnectionStatus	キーコンテナーの所有者によって接続が承認、拒否、または削除されたかどうかを示します。

SecretPermissions

シークレットへのアクセス許可

名前	型	説明
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

SKU の詳細

名前	型	説明
family	SkuFamily	SKU ファミリ名
name	SkuName	キーコンテナーが Standard コンテナーか Premium コンテナーかを指定する SKU 名。

SkuFamily

SKU ファミリ名

名前	型	説明
A	string

SkuName

キーコンテナーが Standard コンテナーか Premium コンテナーかを指定する SKU 名。

名前	型	説明
premium	string
standard	string

StoragePermissions

ストレージアカウントへのアクセス許可

名前	型	説明
all	string
backup	string
delete	string
deletesas	string
get	string
getsas	string
list	string
listsas	string
purge	string
recover	string
regeneratekey	string
restore	string
set	string
setsas	string
update	string

SystemData

キーコンテナーリソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	キーコンテナーリソースの作成 (UTC) のタイムスタンプ。
createdBy	string	キーコンテナーリソースを作成した ID。
createdByType	identityType	キーコンテナーリソースを作成した ID の種類。
lastModifiedAt	string	キーコンテナーリソースの最終変更 (UTC) のタイムスタンプ。
lastModifiedBy	string	キーコンテナーリソースを最後に変更した ID。
lastModifiedByType	identityType	キーコンテナーリソースを最後に変更した ID の種類。

Vault

拡張された詳細を含むリソース情報。

名前	型	説明
id	string	キーコンテナーリソースの完全修飾識別子。
location	string	キーコンテナーリソースの Azure の場所。
name	string	キーコンテナーリソースの名前。
properties	VaultProperties	コンテナーのプロパティ
systemData	SystemData	キーコンテナーのシステムメタデータ。
tags	object	キーコンテナーリソースに割り当てられたタグ。
type	string	キーコンテナーリソースのリソースの種類。

VaultListResult

コンテナーの一覧

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

VaultProperties

コンテナーのプロパティ

名前	型	規定値	説明
accessPolicies	AccessPolicyEntry[]		キーコンテナーにアクセスできる 0 から 1024 の ID の配列。配列内のすべての ID は、キーコンテナーのテナント ID と同じテナント ID を使用する必要があります。がに`recover`設定されている場合`createMode`、アクセスポリシーは必要ありません。それ以外の場合は、アクセスポリシーが必要です。
createMode	CreateMode		コンテナーを復旧する必要があるかどうかを示すコンテナーの作成モード。
enablePurgeProtection	boolean		このコンテナーに対して消去に対する保護を有効にするかどうかを指定するプロパティ。このプロパティを true に設定すると、このコンテナーとそのコンテンツの消去に対する保護がアクティブになります。Key Vault サービスのみが、回復不可能なハード削除を開始する可能性があります。この設定は、論理的な削除も有効になっている場合にのみ有効です。この機能を有効にすることは元に戻すことはできません。つまり、プロパティは false をその値として受け入れません。
enableRbacAuthorization	boolean	False	データアクションの承認方法を制御するプロパティ。 true の場合、キーコンテナーはデータアクションの承認にロールベースのAccess Control (RBAC) を使用し、コンテナーのプロパティで指定されたアクセスポリシーは無視されます。 false の場合、キーコンテナーはコンテナーのプロパティで指定されたアクセスポリシーを使用し、Azure Resource Managerに格納されているすべてのポリシーは無視されます。 null または指定されていない場合、コンテナーは既定値の false で作成されます。管理アクションは常に RBAC で承認されることに注意してください。
enableSoftDelete	boolean	True	このキーコンテナーに対して "論理的な削除" 機能を有効にするかどうかを指定するプロパティ。新しいキーコンテナーの作成時に値 (true または false) に設定されていない場合、既定では true に設定されます。 true に設定すると、false に戻すことはできません。
enabledForDeployment	boolean		キーコンテナーからシークレットとして格納されている証明書を Azure Virtual Machinesで取得できるかどうかを指定するプロパティ。
enabledForDiskEncryption	boolean		コンテナーからシークレットを取得してキーのラップを解除することを Azure Disk Encryption に許可するかどうかを指定するプロパティ。
enabledForTemplateDeployment	boolean		キーコンテナーからシークレットを取得することを Azure Resource Managerに許可するかどうかを指定するプロパティ。
hsmPoolResourceId	string		HSM プールのリソース ID。
networkAcls	NetworkRuleSet		特定のネットワークの場所からのキーコンテナーのアクセシビリティを管理する規則。
privateEndpointConnections	PrivateEndpointConnectionItem[]		キーコンテナーに関連付けられているプライベートエンドポイント接続の一覧。
provisioningState	VaultProvisioningState		コンテナーのプロビジョニング状態。
publicNetworkAccess	string	enabled	コンテナーがパブリックインターネットからのトラフィックを受け入れるかどうかを指定するプロパティ。プライベートエンドポイントトラフィックを除くすべてのトラフィックを "無効" に設定した場合、信頼されたサービスから送信されたトラフィックはブロックされます。これにより、設定されたファイアウォール規則がオーバーライドされます。つまり、ファイアウォール規則が存在する場合でも、規則は適用されません。
sku	Sku		SKU の詳細
softDeleteRetentionInDays	integer	90	softDelete データ保持日数。 =7 と <=90 を受け入れます>。
tenantId	string		キーコンテナーへの要求を認証するために使用する必要がある Azure Active Directory テナント ID。
vaultUri	string		キーとシークレットに対して操作を実行するためのコンテナーの URI。

VaultProvisioningState

コンテナーのプロビジョニング状態。

名前	型	説明
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

特定の仮想ネットワークからのコンテナーのアクセシビリティを制御するルール。

名前	型	説明
id	string	'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' など、vnet サブネットの完全なリソース ID。
ignoreMissingVnetServiceEndpoint	boolean	親サブネットに serviceEndpoints が構成されている場合に NRP がチェックを無視するかどうかを指定するプロパティ。

次の方法で共有