Edit

Share via


Get-AzRedisCacheAccessPolicyAssignment

Get the detailed information about Access Policy Assignment(s) (Redis User(s)) of the Redis Cache

Syntax

NormalParameterSet

Get-AzRedisCacheAccessPolicyAssignment
    -Name <String>
    [-ResourceGroupName <String>]
    [-AccessPolicyAssignmentName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceIdParameterSet

Get-AzRedisCacheAccessPolicyAssignment
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

CacheObjectParameterSet

Get-AzRedisCacheAccessPolicyAssignment
    -TopLevelResourceObject <RedisCacheAttributes>
    [-AccessPolicyAssignmentName <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

If AccessPolicyAssignmentName parameter provided, Get-AzRedisCacheAccessPolicyAssignment cmdlet gets details about the specified access policy assignment (redis user). If only Name is specified this operation gets all access policy assignments (Redis Users) of the Redis Cache.

Examples

Example 1: Get information of an access policy assignment (redis user)

Get-AzRedisCacheAccessPolicyAssignment -Name "testCache" -AccessPolicyAssignmentName "testAccessPolicyAssignment"

This command gets information on access policy assignment (redis user) named testAccessPolicyAssignment from Redis Cache named testCache

Example 2: Get information of all access policy assignments (redis users)

Get-AzRedisCacheAccessPolicyAssignment -Name "testCache"

This command gets information on all access policy assignments from Redis Cache named testCache.

Parameters

-AccessPolicyAssignmentName

Name of Access Policy Assignment.

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
CacheObjectParameterSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
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

-ResourceGroupName

Name of resource group in 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

-ResourceId

ARM Id of Redis Cache Access Policy Assignment

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-TopLevelResourceObject

Object of type RedisCacheAttributes

Parameter properties

Type:RedisCacheAttributes
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CacheObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
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.

Inputs

String

Outputs

PSRedisAccessPolicyAssignment