Vaults - Update Access Policy

Service:

Key Vault

API Version:

2022-07-01

Perbarui kebijakan akses dalam brankas kunci dalam langganan yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
operationKind	path	True	AccessPolicyUpdateKind	Nama operasi
resourceGroupName	path	True	string	Nama Grup Sumber Daya tempat vault berada.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vaultName	path	True	string	Nama vault Regex pattern: ^[a-zA-Z0-9-]{3,24}$
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties	True	VaultAccessPolicyProperties	Properti kebijakan akses

Respons

Nama	Jenis	Deskripsi
200 OK	VaultAccessPolicyParameters	Kebijakan akses yang diperbarui
201 Created	VaultAccessPolicyParameters	Kebijakan akses yang diperbarui
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

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

Sample Request

HTTP

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

Python

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

Definisi

Nama	Deskripsi
AccessPolicyEntry	Identitas yang memiliki akses ke brankas kunci. Semua identitas dalam array harus menggunakan ID penyewa yang sama dengan ID penyewa brankas kunci.
AccessPolicyUpdateKind	Nama operasi
CertificatePermissions	Izin ke sertifikat
CloudError	Respons kesalahan dari penyedia sumber daya Key Vault
CloudErrorBody	Respons kesalahan dari penyedia sumber daya Key Vault
KeyPermissions	Izin ke kunci
Permissions	Izin yang dimiliki identitas untuk kunci, rahasia, sertifikat, dan penyimpanan.
SecretPermissions	Izin ke rahasia
StoragePermissions	Izin ke akun penyimpanan
VaultAccessPolicyParameters	Parameter untuk memperbarui kebijakan akses dalam vault
VaultAccessPolicyProperties	Properti kebijakan akses vault

AccessPolicyEntry

Identitas yang memiliki akses ke brankas kunci. Semua identitas dalam array harus menggunakan ID penyewa yang sama dengan ID penyewa brankas kunci.

Nama	Jenis	Deskripsi
applicationId	string	ID aplikasi klien yang membuat permintaan atas nama prinsipal
objectId	string	ID objek pengguna, perwakilan layanan, atau grup keamanan di penyewa Azure Active Directory untuk vault. ID objek harus unik untuk daftar kebijakan akses.
permissions	Permissions	Izin yang dimiliki identitas untuk kunci, rahasia, dan sertifikat.
tenantId	string	ID penyewa Azure Active Directory yang harus digunakan untuk mengautentikasi permintaan ke brankas kunci.

AccessPolicyUpdateKind

Nama operasi

Nama	Jenis	Deskripsi
add	string
remove	string
replace	string

CertificatePermissions

Izin ke sertifikat

Nama	Jenis	Deskripsi
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

Respons kesalahan dari penyedia sumber daya Key Vault

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons kesalahan dari penyedia sumber daya Key Vault

CloudErrorBody

Respons kesalahan dari penyedia sumber daya Key Vault

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan. Ini adalah mnemonik yang dapat dikonsumsi secara terprogram.
message	string	Pesan kesalahan yang mudah digunakan. Pesan biasanya dilokalkan dan dapat bervariasi menurut versi layanan.

KeyPermissions

Izin ke kunci

Nama	Jenis	Deskripsi
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

Izin yang dimiliki identitas untuk kunci, rahasia, sertifikat, dan penyimpanan.

Nama	Jenis	Deskripsi
certificates	CertificatePermissions[]	Izin ke sertifikat
keys	KeyPermissions[]	Izin ke kunci
secrets	SecretPermissions[]	Izin ke rahasia
storage	StoragePermissions[]	Izin ke akun penyimpanan

SecretPermissions

Izin ke rahasia

Nama	Jenis	Deskripsi
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

StoragePermissions

Izin ke akun penyimpanan

Nama	Jenis	Deskripsi
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

Parameter untuk memperbarui kebijakan akses dalam vault

Nama	Jenis	Deskripsi
id	string	Id sumber daya kebijakan akses.
location	string	Jenis sumber daya kebijakan akses.
name	string	Nama sumber daya kebijakan akses.
properties	VaultAccessPolicyProperties	Properti kebijakan akses
type	string	Nama sumber daya kebijakan akses.

VaultAccessPolicyProperties

Properti kebijakan akses vault

Nama	Jenis	Deskripsi
accessPolicies	AccessPolicyEntry[]	Array 0 hingga 16 identitas yang memiliki akses ke brankas kunci. Semua identitas dalam array harus menggunakan ID penyewa yang sama dengan ID penyewa brankas kunci.