Vaults - Update Access Policy

更新指定訂用帳戶中金鑰保存庫中的存取原則。

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

URI 參數

Name In Required Type Description
operationKind
path True

作業名稱

resourceGroupName
path True
  • string

保存庫所屬的資源群組名稱。

subscriptionId
path True
  • string

可唯一識別Microsoft Azure訂用帳戶的訂用帳號憑證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

vaultName
path True
  • string

保存庫名稱

Regex pattern: ^[a-zA-Z0-9-]{3,24}$

api-version
query True
  • string

用戶端 API 版本。

要求本文

Name Required Type Description
properties True

存取原則的屬性

回應

Name Type Description
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=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"
          ]
        }
      }
    ]
  }
}

定義

AccessPolicyEntry

可存取金鑰保存庫的身分識別。 陣列中的所有身分識別都必須使用與金鑰保存庫租使用者識別碼相同的租使用者識別碼。

AccessPolicyUpdateKind

作業名稱

CloudError

金鑰保存庫資源提供者的錯誤回應

CloudErrorBody

金鑰保存庫資源提供者的錯誤回應

Permissions

身分識別具有金鑰、秘密、憑證和儲存體的許可權。

VaultAccessPolicyParameters

更新保存庫中存取原則的參數

VaultAccessPolicyProperties

保存庫存取原則的屬性

AccessPolicyEntry

可存取金鑰保存庫的身分識別。 陣列中的所有身分識別都必須使用與金鑰保存庫租使用者識別碼相同的租使用者識別碼。

Name Type Description
applicationId
  • string

代表主體提出要求之用戶端的應用程式識別碼

objectId
  • string

保存庫Azure Active Directory租使用者中使用者、服務主體或安全性群組的物件識別碼。 存取原則清單的物件識別碼必須是唯一的。

permissions

身分識別具有金鑰、秘密和憑證的許可權。

tenantId
  • string

應該用來驗證金鑰保存庫要求的Azure Active Directory租使用者識別碼。

AccessPolicyUpdateKind

作業名稱

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

CloudError

金鑰保存庫資源提供者的錯誤回應

Name Type Description
error

金鑰保存庫資源提供者的錯誤回應

CloudErrorBody

金鑰保存庫資源提供者的錯誤回應

Name Type Description
code
  • string

錯誤碼。 這是可透過程式設計方式取用的助憶鍵。

message
  • string

使用者易記的錯誤訊息。 訊息通常是當地語系化的,而且可能會隨著服務版本而有所不同。

Permissions

身分識別具有金鑰、秘密、憑證和儲存體的許可權。

Name Type Description
certificates
  • string[]

憑證的許可權

keys
  • string[]

金鑰的許可權

secrets
  • string[]

秘密的許可權

storage
  • string[]

儲存體帳戶的許可權

VaultAccessPolicyParameters

更新保存庫中存取原則的參數

Name Type Description
id
  • string

存取原則的資源識別碼。

location
  • string

存取原則的資源類型。

name
  • string

存取原則的資源名稱。

properties

存取原則的屬性

type
  • string

存取原則的資源名稱。

VaultAccessPolicyProperties

保存庫存取原則的屬性

Name Type Description
accessPolicies

0 到 16 個身分識別的陣列,可存取金鑰保存庫。 陣列中的所有身分識別都必須使用與金鑰保存庫租使用者識別碼相同的租使用者識別碼。