redis_enterprise

Creates, updates, deletes, gets or lists a redis_enterprise resource.

Overview

Name	`redis_enterprise`
Type	Resource
Id	`azure_isv.redisenterprise.redis_enterprise`

Fields

The following fields are returned by SELECT queries:

get
list_by_resource_group
list

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`encryption`	`object`	Encryption-at-rest configuration for the cluster.
`highAvailability`	`string`	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`hostName`	`string`	DNS name of the cluster endpoint.
`identity`	`object`	The managed service identities assigned to this resource.
`kind`	`string`	Distinguishes the kind of cluster. Read-only. Known values are: "v1" and "v2". (v1, v2)
`location`	`string`	The geo-location where the resource lives. Required.
`maintenanceConfiguration`	`object`	Cluster-level maintenance configuration.
`migratedEndpoint`	`string`	The endpoint of the source resource that is currently pointing to this resource as a result of an ACR/ACRE to AMR migration.
`minimumTlsVersion`	`string`	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. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
`privateEndpointConnections`	`array`	List of private endpoint connections associated with the specified Redis Enterprise cluster.
`provisioningState`	`string`	Current provisioning status of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
`publicNetworkAccess`	`string`	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. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`redisVersion`	`string`	Version of redis the cluster supports, e.g. '6'.
`redundancyMode`	`string`	Explains the current redundancy strategy of the cluster, which affects the expected SLA. Known values are: "None", "LR", and "ZR". (None, LR, ZR)
`resourceState`	`string`	Current resource status of the cluster. Known values are: "Running", "Creating", "CreateFailed", "Updating", "UpdateFailed", "Deleting", "DeleteFailed", "Enabling", "EnableFailed", "Disabling", "DisableFailed", "Disabled", "Scaling", "ScalingFailed", and "Moving". (Running, Creating, CreateFailed, Updating, UpdateFailed, Deleting, DeleteFailed, Enabling, EnableFailed, Disabling, DisableFailed, Disabled, Scaling, ScalingFailed, Moving)
`sku`	`object`	The SKU to create, which affects price, performance, and features. Required.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`zones`	`array`	The availability zones.

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`encryption`	`object`	Encryption-at-rest configuration for the cluster.
`highAvailability`	`string`	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`hostName`	`string`	DNS name of the cluster endpoint.
`identity`	`object`	The managed service identities assigned to this resource.
`kind`	`string`	Distinguishes the kind of cluster. Read-only. Known values are: "v1" and "v2". (v1, v2)
`location`	`string`	The geo-location where the resource lives. Required.
`maintenanceConfiguration`	`object`	Cluster-level maintenance configuration.
`migratedEndpoint`	`string`	The endpoint of the source resource that is currently pointing to this resource as a result of an ACR/ACRE to AMR migration.
`minimumTlsVersion`	`string`	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. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
`privateEndpointConnections`	`array`	List of private endpoint connections associated with the specified Redis Enterprise cluster.
`provisioningState`	`string`	Current provisioning status of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
`publicNetworkAccess`	`string`	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. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`redisVersion`	`string`	Version of redis the cluster supports, e.g. '6'.
`redundancyMode`	`string`	Explains the current redundancy strategy of the cluster, which affects the expected SLA. Known values are: "None", "LR", and "ZR". (None, LR, ZR)
`resourceState`	`string`	Current resource status of the cluster. Known values are: "Running", "Creating", "CreateFailed", "Updating", "UpdateFailed", "Deleting", "DeleteFailed", "Enabling", "EnableFailed", "Disabling", "DisableFailed", "Disabled", "Scaling", "ScalingFailed", and "Moving". (Running, Creating, CreateFailed, Updating, UpdateFailed, Deleting, DeleteFailed, Enabling, EnableFailed, Disabling, DisableFailed, Disabled, Scaling, ScalingFailed, Moving)
`sku`	`object`	The SKU to create, which affects price, performance, and features. Required.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`zones`	`array`	The availability zones.

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`encryption`	`object`	Encryption-at-rest configuration for the cluster.
`highAvailability`	`string`	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. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`hostName`	`string`	DNS name of the cluster endpoint.
`identity`	`object`	The managed service identities assigned to this resource.
`kind`	`string`	Distinguishes the kind of cluster. Read-only. Known values are: "v1" and "v2". (v1, v2)
`location`	`string`	The geo-location where the resource lives. Required.
`maintenanceConfiguration`	`object`	Cluster-level maintenance configuration.
`migratedEndpoint`	`string`	The endpoint of the source resource that is currently pointing to this resource as a result of an ACR/ACRE to AMR migration.
`minimumTlsVersion`	`string`	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. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
`privateEndpointConnections`	`array`	List of private endpoint connections associated with the specified Redis Enterprise cluster.
`provisioningState`	`string`	Current provisioning status of the cluster. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
`publicNetworkAccess`	`string`	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. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
`redisVersion`	`string`	Version of redis the cluster supports, e.g. '6'.
`redundancyMode`	`string`	Explains the current redundancy strategy of the cluster, which affects the expected SLA. Known values are: "None", "LR", and "ZR". (None, LR, ZR)
`resourceState`	`string`	Current resource status of the cluster. Known values are: "Running", "Creating", "CreateFailed", "Updating", "UpdateFailed", "Deleting", "DeleteFailed", "Enabling", "EnableFailed", "Disabling", "DisableFailed", "Disabled", "Scaling", "ScalingFailed", and "Moving". (Running, Creating, CreateFailed, Updating, UpdateFailed, Deleting, DeleteFailed, Enabling, EnableFailed, Disabling, DisableFailed, Disabled, Scaling, ScalingFailed, Moving)
`sku`	`object`	The SKU to create, which affects price, performance, and features. Required.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`zones`	`array`	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get`	`select`	`resource_group_name`, `cluster_name`, `subscription_id`	Gets information about a Redis Enterprise cluster.
`list_by_resource_group`	`select`	`resource_group_name`, `subscription_id`	Lists all Redis Enterprise clusters in a resource group.
`list`	`select`	`subscription_id`	Lists all Redis Enterprise clusters in the specified subscription.
`create`	`insert`	`resource_group_name`, `cluster_name`, `subscription_id`, `location`, `sku`	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.
`update`	`update`	`resource_group_name`, `cluster_name`, `subscription_id`	Updates an existing Redis Enterprise cluster.
`delete`	`delete`	`resource_group_name`, `cluster_name`, `subscription_id`	Deletes a Redis Enterprise cache cluster.
`list_skus_for_scaling`	`exec`	`resource_group_name`, `cluster_name`, `subscription_id`	Lists the available SKUs for scaling the Redis Enterprise cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`cluster_name`	`string`	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. Required.
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`subscription_id`	`string`

`SELECT` examples

get
list_by_resource_group
list

Gets information about a Redis Enterprise cluster.

SELECT
id,
name,
encryption,
highAvailability,
hostName,
identity,
kind,
location,
maintenanceConfiguration,
migratedEndpoint,
minimumTlsVersion,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
redisVersion,
redundancyMode,
resourceState,
sku,
systemData,
tags,
type,
zones
FROM azure_isv.redisenterprise.redis_enterprise
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lists all Redis Enterprise clusters in a resource group.

SELECT
id,
name,
encryption,
highAvailability,
hostName,
identity,
kind,
location,
maintenanceConfiguration,
migratedEndpoint,
minimumTlsVersion,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
redisVersion,
redundancyMode,
resourceState,
sku,
systemData,
tags,
type,
zones
FROM azure_isv.redisenterprise.redis_enterprise
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lists all Redis Enterprise clusters in the specified subscription.

SELECT
id,
name,
encryption,
highAvailability,
hostName,
identity,
kind,
location,
maintenanceConfiguration,
migratedEndpoint,
minimumTlsVersion,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
redisVersion,
redundancyMode,
resourceState,
sku,
systemData,
tags,
type,
zones
FROM azure_isv.redisenterprise.redis_enterprise
WHERE subscription_id = '{{ subscription_id }}' -- required
;

`INSERT` examples

create
Manifest

Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster.

INSERT INTO azure_isv.redisenterprise.redis_enterprise (
tags,
location,
properties,
sku,
zones,
identity,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ zones }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type,
zones
;

# Description fields are for documentation purposes
- name: redis_enterprise
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the redis_enterprise resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the redis_enterprise resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the redis_enterprise resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Other properties of the cluster.
    value:
      highAvailability: "{{ highAvailability }}"
      minimumTlsVersion: "{{ minimumTlsVersion }}"
      encryption:
        customerManagedKeyEncryption:
          keyEncryptionKeyIdentity:
            userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
            identityType: "{{ identityType }}"
          keyEncryptionKeyUrl: "{{ keyEncryptionKeyUrl }}"
      maintenanceConfiguration:
        maintenanceWindows:
          - type: "{{ type }}"
            duration: "{{ duration }}"
            startHourUtc: {{ startHourUtc }}
            schedule:
              dayOfWeek: "{{ dayOfWeek }}"
      hostName: "{{ hostName }}"
      provisioningState: "{{ provisioningState }}"
      redundancyMode: "{{ redundancyMode }}"
      resourceState: "{{ resourceState }}"
      redisVersion: "{{ redisVersion }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      migratedEndpoint: "{{ migratedEndpoint }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
  - name: sku
    description: |
      The SKU to create, which affects price, performance, and features. Required.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

`UPDATE` examples

update

Updates an existing Redis Enterprise cluster.

UPDATE azure_isv.redisenterprise.redis_enterprise
SET 
sku = '{{ sku }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type,
zones;

`DELETE` examples

delete

Deletes a Redis Enterprise cache cluster.

DELETE FROM azure_isv.redisenterprise.redis_enterprise
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_skus_for_scaling

Lists the available SKUs for scaling the Redis Enterprise cluster.

EXEC azure_isv.redisenterprise.redis_enterprise.list_skus_for_scaling 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​