你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Access Policy Assignment - Create Update

服务:: Redis Cache

API 版本:: 2025-07-01

为数据库创建/更新特定访问策略分配

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/accessPolicyAssignments/{accessPolicyAssignmentName}?api-version=2025-07-01

URI 参数

名称	在	必需	类型	说明
accessPolicyAssignmentName	path	True	string pattern: ^[A-Za-z0-9]{1,60}$	Redis Enterprise 数据库访问策略分配的名称。
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Redis Enterprise 群集的名称。名称长度必须为 1-60 个字符。允许的字符（A-Z、a-z、0-9）和连字符（-）。不能有前导和尾随和连续连字符
databaseName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Redis Enterprise 数据库的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
properties.accessPolicyName	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]\|[a-zA-Z0-9])$	特定访问策略分配下的访问策略的名称。目前仅支持“默认”策略。
properties.user	True	User	与访问策略关联的用户。

响应

名称	类型	说明
200 OK	AccessPolicyAssignment	正在创建数据库访问策略分配。检查 provisioningState 和 resourceState 了解详细状态。
201 Created	AccessPolicyAssignment	正在创建数据库访问策略分配。检查 provisioningState 和 resourceState 了解详细状态。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

RedisEnterpriseAccessPolicyAssignmentCreateUpdate

示例请求

PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/accessPolicyAssignments/defaultTestEntraApp1?api-version=2025-07-01

{
  "properties": {
    "accessPolicyName": "default",
    "user": {
      "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0"
    }
  }
}


import com.azure.resourcemanager.redisenterprise.models.AccessPolicyAssignmentPropertiesUser;

/**
 * Samples for AccessPolicyAssignment CreateUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/
     * RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json
     */
    /**
     * Sample code: RedisEnterpriseAccessPolicyAssignmentCreateUpdate.
     * 
     * @param manager Entry point to RedisEnterpriseManager.
     */
    public static void redisEnterpriseAccessPolicyAssignmentCreateUpdate(
        com.azure.resourcemanager.redisenterprise.RedisEnterpriseManager manager) {
        manager.accessPolicyAssignments().define("defaultTestEntraApp1")
            .withExistingDatabase("rg1", "cache1", "default").withAccessPolicyName("default")
            .withUser(new AccessPolicyAssignmentPropertiesUser().withObjectId("6497c918-11ad-41e7-1b0f-7c518a87d0b0"))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redisenterprise
# USAGE
    python redis_enterprise_access_policy_assignment_create_update.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 = RedisEnterpriseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f",
    )

    response = client.access_policy_assignment.begin_create_update(
        resource_group_name="rg1",
        cluster_name="cache1",
        database_name="default",
        access_policy_assignment_name="defaultTestEntraApp1",
        parameters={
            "properties": {"accessPolicyName": "default", "user": {"objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0"}}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.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

package armredisenterprise_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redisenterprise/armredisenterprise/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3855ffb4be0cd4d227b130b67d874fa816736c04/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json
func ExampleAccessPolicyAssignmentClient_BeginCreateUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredisenterprise.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccessPolicyAssignmentClient().BeginCreateUpdate(ctx, "rg1", "cache1", "default", "defaultTestEntraApp1", armredisenterprise.AccessPolicyAssignment{
		Properties: &armredisenterprise.AccessPolicyAssignmentProperties{
			AccessPolicyName: to.Ptr("default"),
			User: &armredisenterprise.AccessPolicyAssignmentPropertiesUser{
				ObjectID: to.Ptr("6497c918-11ad-41e7-1b0f-7c518a87d0b0"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AccessPolicyAssignment = armredisenterprise.AccessPolicyAssignment{
	// 	Name: to.Ptr("defaultTestEntraApp1"),
	// 	Type: to.Ptr("Microsoft.Cache/redisEnterprise/accessPolicyAssignments"),
	// 	ID: to.Ptr("subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroupsrg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/accessPolicyAssignments/default-TestEntraApp1"),
	// 	Properties: &armredisenterprise.AccessPolicyAssignmentProperties{
	// 		AccessPolicyName: to.Ptr("default"),
	// 		ProvisioningState: to.Ptr(armredisenterprise.ProvisioningStateSucceeded),
	// 		User: &armredisenterprise.AccessPolicyAssignmentPropertiesUser{
	// 			ObjectID: to.Ptr("6497c918-11ad-41e7-1b0f-7c518a87d0b0"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { RedisEnterpriseManagementClient } = require("@azure/arm-redisenterprisecache");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates/Updates a particular access policy assignment for a database
 *
 * @summary Creates/Updates a particular access policy assignment for a database
 * x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json
 */
async function redisEnterpriseAccessPolicyAssignmentCreateUpdate() {
  const subscriptionId =
    process.env["REDISENTERPRISE_SUBSCRIPTION_ID"] || "e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f";
  const resourceGroupName = process.env["REDISENTERPRISE_RESOURCE_GROUP"] || "rg1";
  const clusterName = "cache1";
  const databaseName = "default";
  const accessPolicyAssignmentName = "defaultTestEntraApp1";
  const parameters = {
    accessPolicyName: "default",
    user: { objectId: "6497c918-11ad-41e7-1b0f-7c518a87d0b0" },
  };
  const credential = new DefaultAzureCredential();
  const client = new RedisEnterpriseManagementClient(credential, subscriptionId);
  const result = await client.accessPolicyAssignmentOperations.beginCreateUpdateAndWait(
    resourceGroupName,
    clusterName,
    databaseName,
    accessPolicyAssignmentName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.RedisEnterprise;

// Generated from example definition: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json
// this example is just showing the usage of "AccessPolicyAssignment_CreateUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AccessPolicyAssignmentResource created on azure
// for more information of creating AccessPolicyAssignmentResource, please refer to the document of AccessPolicyAssignmentResource
string subscriptionId = "e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f";
string resourceGroupName = "rg1";
string clusterName = "cache1";
string databaseName = "default";
string accessPolicyAssignmentName = "defaultTestEntraApp1";
ResourceIdentifier accessPolicyAssignmentResourceId = AccessPolicyAssignmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName, databaseName, accessPolicyAssignmentName);
AccessPolicyAssignmentResource accessPolicyAssignment = client.GetAccessPolicyAssignmentResource(accessPolicyAssignmentResourceId);

// invoke the operation
AccessPolicyAssignmentData data = new AccessPolicyAssignmentData
{
    AccessPolicyName = "default",
    UserObjectId = Guid.Parse("6497c918-11ad-41e7-1b0f-7c518a87d0b0"),
};
ArmOperation<AccessPolicyAssignmentResource> lro = await accessPolicyAssignment.UpdateAsync(WaitUntil.Completed, data);
AccessPolicyAssignmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AccessPolicyAssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/accessPolicyAssignments/default-TestEntraApp1",
  "name": "defaultTestEntraApp1",
  "type": "Microsoft.Cache/redisEnterprise/accessPolicyAssignments",
  "properties": {
    "provisioningState": "Succeeded",
    "accessPolicyName": "default",
    "user": {
      "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0"
    }
  }
}

状态代码:: 201

{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/accessPolicyAssignments/default-TestEntraApp1",
  "name": "defaultTestEntraApp1",
  "type": "Microsoft.Cache/redisEnterprise/accessPolicyAssignments",
  "properties": {
    "provisioningState": "Succeeded",
    "accessPolicyName": "default",
    "user": {
      "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0"
    }
  }
}

定义

名称	说明
AccessPolicyAssignment	描述Redis企业版数据库的访问策略分配
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	当前预配状态
User	与访问策略关联的用户。

AccessPolicyAssignment

对象

描述Redis企业版数据库的访问策略分配

名称	类型	说明
id	string	资源的完全限定资源 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.provisioningState	ProvisioningState	访问策略分配的当前预配状态。
properties.user	User	与访问策略关联的用户。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ProvisioningState

枚举

当前预配状态

值	说明
Succeeded
Failed
Canceled
Creating
Updating
Deleting

User

对象

与访问策略关联的用户。

名称	类型	说明
objectId	string	用户的对象 ID。