Vaults - Update Access Policy
指定したサブスクリプションのキー コンテナーのアクセス ポリシーを更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/accessPolicies/{operationKind}?api-version=2022-07-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
operation
|
path | True |
操作の名前 |
|
resource
|
path | True |
string |
コンテナーが属するリソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
vault
|
path | True |
string |
コンテナーの名前 Regex pattern: |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties | True |
アクセス ポリシーのプロパティ |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
更新されたアクセス ポリシー |
|
201 Created |
更新されたアクセス ポリシー |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
例
Add an access policy, or update an access policy with new permissions
Sample Request
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/add?api-version=2022-07-01
{
"properties": {
"accessPolicies": [
{
"tenantId": "00000000-0000-0000-0000-000000000000",
"objectId": "00000000-0000-0000-0000-000000000000",
"permissions": {
"keys": [
"encrypt"
],
"secrets": [
"get"
],
"certificates": [
"get"
]
}
}
]
}
}
Sample Response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
"type": "Microsoft.KeyVault/vaults/accessPolicies",
"properties": {
"accessPolicies": [
{
"tenantId": "00000000-0000-0000-0000-000000000000",
"objectId": "00000000-0000-0000-0000-000000000000",
"permissions": {
"keys": [
"encrypt"
],
"secrets": [
"get"
],
"certificates": [
"get"
]
}
}
]
}
}
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
"type": "Microsoft.KeyVault/vaults/accessPolicies",
"properties": {
"accessPolicies": [
{
"tenantId": "00000000-0000-0000-0000-000000000000",
"objectId": "00000000-0000-0000-0000-000000000000",
"permissions": {
"keys": [
"encrypt"
],
"secrets": [
"get"
],
"certificates": [
"get"
]
}
}
]
}
}
定義
名前 | 説明 |
---|---|
Access |
キー コンテナーにアクセスできる ID。 配列内のすべての ID は、キー コンテナーのテナント ID と同じテナント ID を使用する必要があります。 |
Access |
操作の名前 |
Certificate |
証明書に対するアクセス許可 |
Cloud |
リソース プロバイダーからのエラー応答Key Vault |
Cloud |
リソース プロバイダーからのエラー応答Key Vault |
Key |
キーに対するアクセス許可 |
Permissions |
ID がキー、シークレット、証明書、ストレージに対して持つアクセス許可。 |
Secret |
シークレットへのアクセス許可 |
Storage |
ストレージ アカウントへのアクセス許可 |
Vault |
コンテナー内のアクセス ポリシーを更新するためのパラメーター |
Vault |
コンテナー アクセス ポリシーのプロパティ |
AccessPolicyEntry
キー コンテナーにアクセスできる ID。 配列内のすべての ID は、キー コンテナーのテナント ID と同じテナント ID を使用する必要があります。
名前 | 型 | 説明 |
---|---|---|
applicationId |
string |
プリンシパルに代わって要求を行うクライアントのアプリケーション ID |
objectId |
string |
コンテナーの Azure Active Directory テナント内のユーザー、サービス プリンシパル、またはセキュリティ グループのオブジェクト ID。 オブジェクト ID は、アクセス ポリシーの一覧に関して一意である必要があります。 |
permissions |
ID がキー、シークレット、証明書に対して持つアクセス許可。 |
|
tenantId |
string |
キー コンテナーへの要求の認証に使用する必要がある Azure Active Directory テナント ID。 |
AccessPolicyUpdateKind
操作の名前
名前 | 型 | 説明 |
---|---|---|
add |
string |
|
remove |
string |
|
replace |
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 |
リソース プロバイダーからのエラー応答Key Vault |
CloudErrorBody
リソース プロバイダーからのエラー応答Key Vault
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 これは、プログラムで使用できるニーモニックです。 |
message |
string |
わかりやすいエラー メッセージ。 通常、メッセージはローカライズされており、サービスのバージョンによって異なる場合があります。 |
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 |
Permissions
ID がキー、シークレット、証明書、ストレージに対して持つアクセス許可。
名前 | 型 | 説明 |
---|---|---|
certificates |
証明書に対するアクセス許可 |
|
keys |
キーに対するアクセス許可 |
|
secrets |
シークレットへのアクセス許可 |
|
storage |
ストレージ アカウントへのアクセス許可 |
SecretPermissions
シークレットへのアクセス許可
名前 | 型 | 説明 |
---|---|---|
all |
string |
|
backup |
string |
|
delete |
string |
|
get |
string |
|
list |
string |
|
purge |
string |
|
recover |
string |
|
restore |
string |
|
set |
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 |
VaultAccessPolicyParameters
コンテナー内のアクセス ポリシーを更新するためのパラメーター
名前 | 型 | 説明 |
---|---|---|
id |
string |
アクセス ポリシーのリソース ID。 |
location |
string |
アクセス ポリシーのリソースの種類。 |
name |
string |
アクセス ポリシーのリソース名。 |
properties |
アクセス ポリシーのプロパティ |
|
type |
string |
アクセス ポリシーのリソース名。 |
VaultAccessPolicyProperties
コンテナー アクセス ポリシーのプロパティ
名前 | 型 | 説明 |
---|---|---|
accessPolicies |
キー コンテナーにアクセスできる 0 から 16 個の ID の配列。 配列内のすべての ID は、キー コンテナーのテナント ID と同じテナント ID を使用する必要があります。 |