New-AzRedisEnterpriseCache

Syntax

CreateClusterWithDatabase (Default)

New-AzRedisEnterpriseCache
 -ClusterName <String>
 -ResourceGroupName <String>
 -Location <String>
 -Sku <String>
 [-SubscriptionId <String>]
 [-Capacity <Int32>]
 [-MinimumTlsVersion <String>]
 [-Zone <String[]>]
 [-Tag <Hashtable>]
 [-Module <IModule[]>]
 [-ClientProtocol <String>]
 [-Port <Int32>]
 [-EvictionPolicy <String>]
 [-GroupNickname <String>]
 [-LinkedDatabase <ILinkedDatabase[]>]
 [-ClusteringPolicy <String>]
 [-AccessKeysAuthentication <String>]
 [-CustomerManagedKeyEncryptionKeyUrl <String>]
 [-HighAvailability <String>]
 [-PublicNetworkAccess <String>]
 [-EnableSystemAssignedIdentity]
 [-UserAssignedIdentity <String[]>]
 [-KeyEncryptionKeyIdentityType <String>]
 [-KeyEncryptionKeyIdentityUserAssignedIdentityResourceId <String>]
 [-AofPersistenceEnabled]
 [-AofPersistenceFrequency <String>]
 [-RdbPersistenceEnabled]
 [-RdbPersistenceFrequency <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateClusterOnly

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

Description

Examples

Example 1: Create a Redis Enterprise cache

New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "West US" -Sku "Enterprise_E10"

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

Example 2: Create a Redis Enterprise cache using some optional parameters

New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "East US" -Sku "Enterprise_E20" -Capacity 4 -MinimumTlsVersion "1.2" -Zone "1","2","3" -Tag @{"tag1" = "value1"} -Module "{name:RedisBloom, args:`"ERROR_RATE 0.00 INITIAL_SIZE 400`"}","{name:RedisTimeSeries, args:`"RETENTION_POLICY 20`"}","{name:RediSearch}" -ClientProtocol "Plaintext" -EvictionPolicy "NoEviction" -ClusteringPolicy "EnterpriseCluster" -AofPersistenceEnabled -AofPersistenceFrequency "1s"

Location Name Type Zone Database
-------- ---- ---- ---- --------
East US MyCache Microsoft.Cache/redisEnterprise {1, 2, 3} {default}

Example 3: Advanced - Create a Redis Enterprise cache cluster without an associated database

New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "East US" -Sku "EnterpriseFlash_F300" -NoDatabase

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

Example 4: Create a Redis Enterprise cache with a georeplicated database

New-AzRedisEnterpriseCache -Name "MyCache" -ResourceGroupName "MyGroup" -Location "West US" -Sku "Enterprise_E10" -ClientProtocol "Encrypted" -EvictionPolicy "NoEviction" -ClusteringPolicy "EnterpriseCluster" -GroupNickname "GroupNickname" -LinkedDatabase '{id:"/subscriptions/6b9ac7d2-7f6d-4de4-962c-43fda44bc3f2/resourceGroups/MyGroup/providers/Microsoft.Cache/redisEnterprise/MyCache/databases/default"}'

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

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

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

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

Parameter sets

-AsJob

Run the command as a job

Parameter properties

Parameter sets

-Capacity

The size of the RedisEnterprise cluster. Defaults to 2 or 3 or not applicable depending on SKU.Valid values are (2, 4, 6, ...) for Enterprise_* SKUs and (3, 9, 15, ...) for EnterpriseFlash_* SKUs. For other SKUs capacity argument is not supported.

Parameter properties

Parameter sets

-ClientProtocol

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols - default is Encrypted Allowed values: Encrypted, Plaintext

Parameter properties

Parameter sets

-ClusteringPolicy

Clustering policy - default is OSSCluster Specified at create time. Allowed values: EnterpriseCluster, OSSCluster

Parameter properties

Parameter sets

-ClusterName

The name of the Redis Enterprise cluster.

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 credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Parameter sets

-EnableSystemAssignedIdentity

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

Parameter properties

Parameter sets

-EvictionPolicy

Redis eviction policy - default is VolatileLRU Allowed values: AllKeysLFU, AllKeysLRU, AllKeysRandom, VolatileLRU, VolatileLFU, VolatileTTL, VolatileRandom, NoEviction

Parameter properties

Parameter sets

-GroupNickname

Name for the group of linked database resources

Parameter properties

Parameter sets

-HighAvailability

Enabled by default. Can only be updated from disabled to enabled. 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

-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

-LinkedDatabase

List of database resources to link with this database To construct, see NOTES section for GEOREPLICATIONLINKEDDATABASE properties and create a hash table.

Parameter properties

Parameter sets

-Location

The geo-location where the resource lives.

Parameter properties

Parameter sets

-MinimumTlsVersion

The minimum TLS version for the cluster to support - default is 1.2 Allowed values: 1.0, 1.1, 1.2

Parameter properties

Parameter sets

-Module

Optional set of redis modules to enable in this database - modules can only be added at create time. To construct, see NOTES section for MODULE properties and create a hash table.

Parameter properties

Parameter sets

-NoDatabase

Advanced - Do not automatically create a default database. Warning: The cache will not be usable until you create a database.

Parameter properties

Parameter sets

-NoWait

Run the command asynchronously

Parameter properties

Parameter sets

-Port

TCP port of the database endpoint - defaults to an available port Specified at create time.

Parameter properties

Parameter sets

-PublicNetworkAccess

Whether or not public network traffic can access the Redis cluster. Only 'Enabled' or 'Disabled' can be set.

Parameter properties

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

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

Parameter sets

-ResourceGroupName

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

Parameter properties

Parameter sets

-Sku

The type of RedisEnterprise cluster to deploy. Accepted values: Balanced_B0, Balanced_B1, Balanced_B10, Balanced_B100, Balanced_B1000, Balanced_B150, Balanced_B20, Balanced_B250, Balanced_B3, Balanced_B350, Balanced_B5, Balanced_B50, Balanced_B500, Balanced_B700, ComputeOptimized_X10, ComputeOptimized_X100, ComputeOptimized_X150, ComputeOptimized_X20, ComputeOptimized_X250, ComputeOptimized_X3, ComputeOptimized_X350, ComputeOptimized_X5, ComputeOptimized_X50, ComputeOptimized_X500, ComputeOptimized_X700, EnterpriseFlash_F1500, EnterpriseFlash_F300, EnterpriseFlash_F700, Enterprise_E1, Enterprise_E10, Enterprise_E100, Enterprise_E20, Enterprise_E200, Enterprise_E400, Enterprise_E5, Enterprise_E50, FlashOptimized_A1000, FlashOptimized_A1500, FlashOptimized_A2000, FlashOptimized_A250, FlashOptimized_A4500, FlashOptimized_A500, FlashOptimized_A700, MemoryOptimized_M10, MemoryOptimized_M100, MemoryOptimized_M1000, MemoryOptimized_M150, MemoryOptimized_M1500, MemoryOptimized_M20, MemoryOptimized_M2000, MemoryOptimized_M250, MemoryOptimized_M350, MemoryOptimized_M50, MemoryOptimized_M500, MemoryOptimized_M700

Parameter properties

Parameter sets

-SubscriptionId

The ID of the target subscription.

Parameter properties

Parameter sets

-Tag

Cluster 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

Outputs

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