Vaults - Update Access Policy

リファレンス

Service:: Key Vault

API Version:: 2022-07-01

指定したサブスクリプションのキーコンテナーのアクセスポリシーを更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/accessPolicies/{operationKind}?api-version=2022-07-01

URI パラメーター

名前	/	必須	型	説明
operationKind	path	True	AccessPolicyUpdateKind	操作の名前
resourceGroupName	path	True	string	コンテナーが属するリソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
vaultName	path	True	string	コンテナーの名前 Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
properties	True	VaultAccessPolicyProperties	アクセスポリシーのプロパティ

応答

名前	型	説明
200 OK	VaultAccessPolicyParameters	更新されたアクセスポリシー
201 Created	VaultAccessPolicyParameters	更新されたアクセスポリシー
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

例

Add an access policy, or update an access policy with new permissions

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"
          ]
        }
      }
    ]
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python update_access_policies_add.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.update_access_policy(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        operation_kind="add",
        parameters={
            "properties": {
                "accessPolicies": [
                    {
                        "objectId": "00000000-0000-0000-0000-000000000000",
                        "permissions": {"certificates": ["get"], "keys": ["encrypt"], "secrets": ["get"]},
                        "tenantId": "00000000-0000-0000-0000-000000000000",
                    }
                ]
            }
        },
    )
    print(response)


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

{
  "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"
          ]
        }
      }
    ]
  }
}

Status code:: 201

{
  "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"
          ]
        }
      }
    ]
  }
}

定義

名前	説明
AccessPolicyEntry	キーコンテナーにアクセスできる ID。配列内のすべての ID は、キーコンテナーのテナント ID と同じテナント ID を使用する必要があります。
AccessPolicyUpdateKind	操作の名前
CertificatePermissions	証明書に対するアクセス許可
CloudError	リソースプロバイダーからのエラー応答Key Vault
CloudErrorBody	リソースプロバイダーからのエラー応答Key Vault
KeyPermissions	キーに対するアクセス許可
Permissions	ID がキー、シークレット、証明書、ストレージに対して持つアクセス許可。
SecretPermissions	シークレットへのアクセス許可
StoragePermissions	ストレージアカウントへのアクセス許可
VaultAccessPolicyParameters	コンテナー内のアクセスポリシーを更新するためのパラメーター
VaultAccessPolicyProperties	コンテナーアクセスポリシーのプロパティ

AccessPolicyEntry

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

名前	型	説明
applicationId	string	プリンシパルに代わって要求を行うクライアントのアプリケーション ID
objectId	string	コンテナーの Azure Active Directory テナント内のユーザー、サービスプリンシパル、またはセキュリティグループのオブジェクト ID。オブジェクト ID は、アクセスポリシーの一覧に関して一意である必要があります。
permissions	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	CloudErrorBody	リソースプロバイダーからのエラー応答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	CertificatePermissions[]	証明書に対するアクセス許可
keys	KeyPermissions[]	キーに対するアクセス許可
secrets	SecretPermissions[]	シークレットへのアクセス許可
storage	StoragePermissions[]	ストレージアカウントへのアクセス許可

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	VaultAccessPolicyProperties	アクセスポリシーのプロパティ
type	string	アクセスポリシーのリソース名。

VaultAccessPolicyProperties

コンテナーアクセスポリシーのプロパティ

名前	型	説明
accessPolicies	AccessPolicyEntry[]	キーコンテナーにアクセスできる 0 から 16 個の ID の配列。配列内のすべての ID は、キーコンテナーのテナント ID と同じテナント ID を使用する必要があります。