Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-AzRedisEnterpriseCacheKey
- Module:
- Az.RedisEnterpriseCache Module
Regenerates an access key for a Redis Enterprise database.
Syntax
Default (Default)
New-AzRedisEnterpriseCacheKey
-ClusterName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-KeyType <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Regenerates an access key for a Redis Enterprise database.
Examples
Example 1: Regenerate primary access key
New-AzRedisEnterpriseCacheKey -Name "MyCache" -ResourceGroupName "MyGroup" -KeyType "Primary"
PrimaryKey SecondaryKey
---------- ------------
new-primary-key secondary-key
This command regenerates the primary secret access key used for authenticating connections to the database of the Redis Enterprise cache named MyCache.
Example 2: Regenerate secondary access key
New-AzRedisEnterpriseCacheKey -Name "MyCache" -ResourceGroupName "MyGroup" -KeyType "Secondary"
PrimaryKey SecondaryKey
---------- ------------
primary-key new-secondary-key
This command regenerates the secondary secret access key used for authenticating connections to the database of the Redis Enterprise cache named MyCache.
Parameters
-AsJob
Run the command as a job
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ClusterName
The name of the Redis Enterprise cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
-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
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
-KeyType
Which access key to regenerate.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NoWait
Run the command asynchronously
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
The ID of the target subscription.
Parameter properties
| Type: | String |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
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
Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IAccessKeys
Notes
ALIASES
New-AzRedisEnterpriseCacheDatabaseKey
New-AzRedisEnterpriseCacheAccessKey
Azure PowerShell
Feedback
Was this page helpful?