Remove-AzRedisCacheAccessPolicyAssignment

Module:

Az.RedisCache Module

Delete the Access Policy Assignment (Redis User)

Syntax

NormalParameterSet (Default)

Remove-AzRedisCacheAccessPolicyAssignment
    -Name <String>
    -AccessPolicyAssignmentName <String>
    [-ResourceGroupName <String>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CacheObjectParameterSet

Remove-AzRedisCacheAccessPolicyAssignment
    -AccessPolicyAssignmentName <String>
    -TopLevelResourceObject <RedisCacheAttributes>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceIdParameterSet

Remove-AzRedisCacheAccessPolicyAssignment
    -ResourceId <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RedisCacheAccessPolicyAssignmentObject

Remove-AzRedisCacheAccessPolicyAssignment
    -InputObject <PSRedisAccessPolicyAssignment>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Remove an Access Policy Assignment (Redis User) from a Redis Cache.

Examples

Example 1

Remove-AzRedisCacheAccessPolicyAssignment -Name "testCacheName" -AccessPolicyAssignmentName "testAccessPolicyAssignmentName"

This command removes an Access Policy Assignment (Redis User) named testAccessPolicyAssignmentName from Redis Cache named testCacheName.

Parameters

-AccessPolicyAssignmentName

The name of the Access Policy Assignment that is being deleted from the 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

CacheObjectParameterSet

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

-InputObject

Object of type RedisCacheAccessPolicyAssignment

Parameter properties

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

Parameter sets

RedisCacheAccessPolicyAssignmentObject

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

-PassThru

{{ Fill PassThru Description }}

Parameter properties

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

Parameter sets

(All)

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

-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.

Inputs

String

PSRedisAccessPolicyAssignment

Outputs

Boolean