Microsoft.Cache redis/accessPolicyAssignments

• Latest
• 2023-08-01
• 2023-05-01-preview

Bicep resource definition

The redis/accessPolicyAssignments resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis/accessPolicyAssignments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cache/redis/accessPolicyAssignments@2023-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    accessPolicyName: 'string'
    objectId: 'string'
    objectIdAlias: 'string'
  }
}

Property values

redis/accessPolicyAssignments

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: redis
properties	Properties of an access policy assignment	RedisCacheAccessPolicyAssignmentProperties

RedisCacheAccessPolicyAssignmentProperties

Name	Description	Value
accessPolicyName	The name of the access policy that is being assigned	string (required) Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$
objectId	Object Id to assign access policy to	string (required)
objectIdAlias	User friendly name for object id. Also represents username for token based authentication	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Redis Cache with Microsoft Entra Authentication.	This template creates a Redis Cache. Then assigns a built-in access policy to a redis user. Then creates a custom access policy. And then assigns the custom access policy to another Redis user.

ARM template resource definition

The redis/accessPolicyAssignments resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis/accessPolicyAssignments resource, add the following JSON to your template.

{
  "type": "Microsoft.Cache/redis/accessPolicyAssignments",
  "apiVersion": "2023-08-01",
  "name": "string",
  "properties": {
    "accessPolicyName": "string",
    "objectId": "string",
    "objectIdAlias": "string"
  }
}

Property values

redis/accessPolicyAssignments

Name	Description	Value
type	The resource type	'Microsoft.Cache/redis/accessPolicyAssignments'
apiVersion	The resource api version	'2023-08-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
properties	Properties of an access policy assignment	RedisCacheAccessPolicyAssignmentProperties

RedisCacheAccessPolicyAssignmentProperties

Name	Description	Value
accessPolicyName	The name of the access policy that is being assigned	string (required) Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$
objectId	Object Id to assign access policy to	string (required)
objectIdAlias	User friendly name for object id. Also represents username for token based authentication	string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Redis Cache with Microsoft Entra Authentication.	This template creates a Redis Cache. Then assigns a built-in access policy to a redis user. Then creates a custom access policy. And then assigns the custom access policy to another Redis user.

Terraform (AzAPI provider) resource definition

The redis/accessPolicyAssignments resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis/accessPolicyAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redis/accessPolicyAssignments@2023-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      accessPolicyName = "string"
      objectId = "string"
      objectIdAlias = "string"
    }
  })
}

Property values

redis/accessPolicyAssignments

Name	Description	Value
type	The resource type	"Microsoft.Cache/redis/accessPolicyAssignments@2023-08-01"
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: redis
properties	Properties of an access policy assignment	RedisCacheAccessPolicyAssignmentProperties

RedisCacheAccessPolicyAssignmentProperties

Name	Description	Value
accessPolicyName	The name of the access policy that is being assigned	string (required) Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$
objectId	Object Id to assign access policy to	string (required)
objectIdAlias	User friendly name for object id. Also represents username for token based authentication	string (required)