Access Policy Assignment - Create Update

服務:

Redis Cache

API 版本:

2024-11-01

將存取原則指派新增至指定的使用者

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}?api-version=2024-11-01

URI 參數

名稱	位於	必要	類型	Description
accessPolicyAssignmentName	path	True	string minLength: 3 maxLength: 63 pattern: ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$	存取原則指派的名稱。
cacheName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$	Redis 快取的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
properties.accessPolicyName	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9- ]*[a-zA-Z0-9]|[a-zA-Z0-9])$	要指派之存取原則的名稱
properties.objectId	True	string	要指派存取原則的物件標識碼
properties.objectIdAlias	True	string	物件識別碼的用戶易記名稱。也代表令牌型驗證的用戶名稱

回應

名稱	類型	Description
200 OK	RedisCacheAccessPolicyAssignment	資源 'RedisCacheAccessPolicyAssignment' 更新作業成功
201 Created	RedisCacheAccessPolicyAssignment	資源 'RedisCacheAccessPolicyAssignment' 建立作業成功 標題 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

RedisCacheAccessPolicyAssignmentCreateUpdate

範例要求

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName1?api-version=2024-11-01

{
  "properties": {
    "accessPolicyName": "accessPolicy1",
    "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0",
    "objectIdAlias": "TestAADAppRedis"
  }
}

範例回覆

狀態碼:

200

{
  "name": "accessPolicyAssignmentName1",
  "type": "Microsoft.Cache/Redis/accessPolicyAssignments",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName1",
  "properties": {
    "accessPolicyName": "accessPolicy1",
    "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0",
    "objectIdAlias": "TestAADAppRedis",
    "provisioningState": "Succeeded"
  }
}

狀態碼:

201

{
  "name": "accessPolicyAssignmentName1",
  "type": "Microsoft.Cache/Redis/accessPolicyAssignments",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName1",
  "properties": {
    "accessPolicyName": "accessPolicy1",
    "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0",
    "objectIdAlias": "TestAADAppRedis",
    "provisioningState": "Succeeded"
  }
}

定義

名稱	Description
AccessPolicyAssignmentProvisioningState	設定存取原則指派集的布建狀態
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
RedisCacheAccessPolicyAssignment	回應存取原則指派上的作業
systemData	與建立和上次修改資源相關的元數據。

AccessPolicyAssignmentProvisioningState

列舉型別

設定存取原則指派集的布建狀態

值	Description
Updating	正在更新存取原則指派
Succeeded	存取原則指派已成功更新
Deleting	正在刪除存取原則指派
Deleted	存取原則指派會被視為已刪除，這表示不會套用任何自訂存取原則。
Canceled	該行動被取消。 存取原則指派可能處於部分更新狀態。 再次更新它們以具有明確定義的狀態。
Failed	作業失敗。 存取原則指派可能處於部分更新狀態。 再次更新它們以具有明確定義的狀態。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

RedisCacheAccessPolicyAssignment

Object

回應存取原則指派上的作業

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.accessPolicyName	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9- ]*[a-zA-Z0-9]|[a-zA-Z0-9])$	要指派之存取原則的名稱
properties.objectId	string	要指派存取原則的物件標識碼
properties.objectIdAlias	string	物件識別碼的用戶易記名稱。也代表令牌型驗證的用戶名稱
properties.provisioningState	AccessPolicyAssignmentProvisioningState	設定存取原則指派集的布建狀態
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。