Update-AzRedisEnterpriseCache

Syntax

UpdateExpanded (Default)

Update-AzRedisEnterpriseCache
 -ClusterName <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-Capacity <Int32>]
 [-CustomerManagedKeyEncryptionKeyUrl <String>]
 [-EnableSystemAssignedIdentity <Boolean>]
 [-HighAvailability <String>]
 [-KeyEncryptionKeyIdentityType <String>]
 [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>]
 [-MinimumTlsVersion <String>]
 [-PublicNetworkAccess <String>]
 [-Sku <String>]
 [-Tag <Hashtable>]
 [-UserAssignedIdentity <String[]>]
 [-Zone <String[]>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UpdateViaIdentityExpanded

Update-AzRedisEnterpriseCache
 -InputObject <IRedisEnterpriseCacheIdentity>
 [-Capacity <Int32>]
 [-CustomerManagedKeyEncryptionKeyUrl <String>]
 [-EnableSystemAssignedIdentity <Boolean>]
 [-HighAvailability <String>]
 [-KeyEncryptionKeyIdentityType <String>]
 [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>]
 [-MinimumTlsVersion <String>]
 [-PublicNetworkAccess <String>]
 [-Sku <String>]
 [-Tag <Hashtable>]
 [-UserAssignedIdentity <String[]>]
 [-Zone <String[]>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Examples

Example 1: Update Redis Enterprise cache

Update-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -MinimumTlsVersion "1.2" -Tag @{"tag1" = "value1"}

Location Name Type Zone Database
-------- ---- ---- ---- --------
West US MyCache Microsoft.Cache/redisEnterprise {default}

Parameters

-AsJob

Run the command as a job

Parameter properties

Parameter sets

-Capacity

This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs.

Parameter properties

Parameter sets

-ClusterName

The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens

Parameter properties

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-CustomerManagedKeyEncryptionKeyUrl

Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Parameter properties

Parameter sets

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Parameter sets

-EnableSystemAssignedIdentity

Determines whether to enable a system-assigned identity for the resource.

Parameter properties

Parameter sets

-HighAvailability

Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.

Parameter properties

Parameter sets

-InputObject

Identity Parameter

Parameter properties

Parameter sets

-KeyEncryptionKeyIdentityType

Only userAssignedIdentity is supported in this API version; other types may be supported in the future

Parameter properties

Parameter sets

-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId

User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.

Parameter properties

Parameter sets

-MinimumTlsVersion

The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions.

Parameter properties

Parameter sets

-NoWait

Run the command asynchronously

Parameter properties

Parameter sets

-PublicNetworkAccess

Whether or not public network traffic can access the Redis cluster. Only 'Enabled' or 'Disabled' can be set. null is returned only for clusters created using an old API version which do not have this property and cannot be set.

Parameter properties

Parameter sets

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Parameter sets

-Sku

The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future.

Parameter properties

Parameter sets

-SubscriptionId

The ID of the target subscription.

Parameter properties

Parameter sets

-Tag

Resource tags.

Parameter properties

Parameter sets

-UserAssignedIdentity

The array of user assigned identities associated with the resource. The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'

Parameter properties

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Parameter sets

-Zone

The Availability Zones where this cluster will be deployed.

Parameter properties

Parameter sets

CommonParameters

Inputs

IRedisEnterpriseCacheIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Models.ICluster