Vaults - Update Access Policy

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=2021-10-01

Parameter URI

Name In Required Type Description
operationKind
path True

Nama operasi

resourceGroupName
path True
  • string

Nama Grup Sumber Daya tempat vault berada.

subscriptionId
path True
  • string

Info masuk 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

Name Required Type Description
properties True

Properti kebijakan akses

Respons

Name Type Description
200 OK

Kebijakan akses yang diperbarui

201 Created

Kebijakan akses yang diperbarui

Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

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=2021-10-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"
          ]
        }
      }
    ]
  }
}

Definisi

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

CloudError

Respons kesalahan dari penyedia sumber daya Key Vault

CloudErrorBody

Respons kesalahan dari penyedia sumber daya Key Vault

Permissions

Izin yang dimiliki identitas untuk kunci, rahasia, sertifikat, dan 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.

Name Type Description
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

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

Name Type Description
add
  • string
remove
  • string
replace
  • string

CloudError

Respons kesalahan dari penyedia sumber daya Key Vault

Name Type Description
error

Respons kesalahan dari penyedia sumber daya Key Vault

CloudErrorBody

Respons kesalahan dari penyedia sumber daya Key Vault

Name Type Description
code
  • string

Kode Kesalahan. Ini adalah mnemonic yang dapat dikonsumsi secara terprogram.

message
  • string

Pesan kesalahan yang mudah digunakan. Pesan biasanya dilokalkan dan dapat bervariasi menurut versi layanan.

Permissions

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

Name Type Description
certificates
  • string[]

Izin ke sertifikat

keys
  • string[]

Izin ke kunci

secrets
  • string[]

Izin ke rahasia

storage
  • string[]

Izin ke akun penyimpanan

VaultAccessPolicyParameters

Parameter untuk memperbarui kebijakan akses dalam vault

Name Type Description
id
  • string

Id sumber daya kebijakan akses.

location
  • string

Jenis sumber daya kebijakan akses.

name
  • string

Nama sumber daya kebijakan akses.

properties

Properti kebijakan akses

type
  • string

Nama sumber daya kebijakan akses.

VaultAccessPolicyProperties

Properti kebijakan akses vault

Name Type Description
accessPolicies

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.