Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-AzRedisEnterpriseCacheDatabase
- Module:
- Az.RedisEnterpriseCache Module
Updates an existing Redis Enterprise database
Syntax
UpdateExpanded (Default)
Update-AzRedisEnterpriseCacheDatabase
-ClusterName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AccessKeysAuthentication <String>]
[-ClientProtocol <String>]
[-EvictionPolicy <String>]
[-AofPersistenceEnabled]
[-AofPersistenceFrequency <String>]
[-RdbPersistenceEnabled]
[-RdbPersistenceFrequency <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzRedisEnterpriseCacheDatabase
-InputObject <IRedisEnterpriseCacheIdentity>
[-AccessKeysAuthentication <String>]
[-ClientProtocol <String>]
[-EvictionPolicy <String>]
[-AofPersistenceEnabled]
[-AofPersistenceFrequency <String>]
[-RdbPersistenceEnabled]
[-RdbPersistenceFrequency <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates an existing Redis Enterprise database
Examples
Example 1: Update client protocol property of a database
Update-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" -ClientProtocol "Plaintext"
Name Type
---- ----
default Microsoft.Cache/redisEnterprise/databases
This command updates the client protocol of the database for the Redis Enterprise cache named MyCache.
Example 2: Update client protocol and eviction policy properties of a database
Update-AzRedisEnterpriseCacheDatabase -Name "MyCache" -ResourceGroupName "MyGroup" -ClientProtocol "Encrypted" -EvictionPolicy "NoEviction"
Name Type
---- ----
default Microsoft.Cache/redisEnterprise/databases
This command updates the client protocol and eviction policy of the database for the Redis Enterprise cache named MyCache.
Parameters
-AccessKeysAuthentication
This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AofPersistenceEnabled
[Preview] Sets whether AOF persistence is enabled. After enabling AOF persistence, you will be unable to disable it. Support for disabling AOF persistence after enabling will be added at a later date.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AofPersistenceFrequency
[Preview] Sets the frequency at which data is written to disk if AOF persistence is enabled. Allowed values: 1s, always
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AsJob
Run the command as a job
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ClientProtocol
Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Allowed values: Encrypted, Plaintext
Parameter properties
| Type: | String |
| 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
-EvictionPolicy
Redis eviction policy. Allowed values: AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom, NoEviction
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | IRedisEnterpriseCacheIdentity |
| 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
-RdbPersistenceEnabled
[Preview] Sets whether RDB persistence is enabled. After enabling RDB persistence, you will be unable to disable it. Support for disabling RDB persistence after enabling will be added at a later date.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RdbPersistenceFrequency
[Preview] Sets the frequency at which a snapshot of the database is created if RDB persistence is enabled. Allowed values: 1h, 6h, 12h
Parameter properties
| Type: | String |
| 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.
Inputs
IRedisEnterpriseCacheIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.IDatabase
Azure PowerShell
Feedback
Was this page helpful?