New-AzRedisCacheAccessPolicy
Add an Access Policy to the Redis Cache
Syntax
NormalParameterSet (Default)
New-AzRedisCacheAccessPolicy
-Name <String>
-AccessPolicyName <String>
-Permission <String>
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CacheObjectParameterSet
New-AzRedisCacheAccessPolicy
-TopLevelResourceObject <RedisCacheAttributes>
-AccessPolicyName <String>
-Permission <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create an access policy for a Redis Cache.
Examples
Example 1: Create an access policy
New-AzRedisCacheAccessPolicy -Name "testCache" -AccessPolicyName "testAccessPolicy" -Permission "+get +hget"
This command creates access policy named testAccessPolicy on Redis Cache named testCache.
Parameters
-AccessPolicyName
The name of the access policy that is being added to the Redis cache.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of redis cache.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NormalParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Permission
Permissions for the access policy.
Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Name of resource group under which cache exists.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
NormalParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-TopLevelResourceObject
Object of type RedisCacheAttributes
Parameter properties
Parameter sets
CacheObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
