次の方法で共有


Vaults - List By Subscription

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

応答のサンプル

{
  "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 がチェックを無視するかどうかを指定するプロパティ。