Access Policy Assignment - Create Update

Služba:

Redis Cache

Verze rozhraní API:

2025-07-01

Vytvoří nebo aktualizuje konkrétní přiřazení zásad přístupu pro databázi.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accessPolicyAssignmentName	path	True	string pattern: ^[A-Za-z0-9]{1,60}$	Název přiřazení zásad přístupu k databázi Redis Enterprise.
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Název clusteru Redis Enterprise. Název musí mít délku 1 až 60 znaků. Povolené znaky(A-Z, a-z, 0-9) a spojovník(-). Nesmí existovat žádné úvodní ani koncové ani po sobě jdoucí pomlčky.
databaseName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Název databáze Redis Enterprise.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.accessPolicyName	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$	Název zásady přístupu v rámci přiřazení konkrétní zásady přístupu V tuto chvíli se podporují jenom výchozí zásady.
properties.user	True	User	Uživatel přidružený k zásadám přístupu.

Odpovědi

Name	Typ	Description
200 OK	AccessPolicyAssignment	Vytváří se přiřazení zásady přístupu k databázi. Podrobný stav najdete v provisioningState a resourceState.
201 Created	AccessPolicyAssignment	Vytváří se přiřazení zásady přístupu k databázi. Podrobný stav najdete v provisioningState a resourceState.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

RedisEnterpriseAccessPolicyAssignmentCreateUpdate

Ukázkový požadavek

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

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

Definice

Name	Description
AccessPolicyAssignment	Popisuje přiřazení zásad přístupu databáze Redis Enterprise
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ProvisioningState	Aktuální stav zřizování
User	Uživatel přidružený k zásadám přístupu.

AccessPolicyAssignment

Objekt

Popisuje přiřazení zásad přístupu databáze Redis Enterprise

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.accessPolicyName	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$	Název zásady přístupu v rámci přiřazení konkrétní zásady přístupu V tuto chvíli se podporují jenom výchozí zásady.
properties.provisioningState	ProvisioningState	Aktuální stav zřizování přiřazení zásad přístupu.
properties.user	User	Uživatel přidružený k zásadám přístupu.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ProvisioningState

Výčet

Aktuální stav zřizování

Hodnota	Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

User

Objekt

Uživatel přidružený k zásadám přístupu.

Name	Typ	Description
objectId	string	ID objektu uživatele.