redis_enterprises

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

Overview

Name	redis_enterprises
Type	Resource
Id	azure_isv.redis_enterprise.redis_enterprises

Fields

The following fields are returned by SELECT queries:

get

The request succeeded, response body contains the requested details.

Name	Datatype	Description
identity	object	The identity of the resource.
location	string	The geo-location where the resource lives
properties	object	Other properties of the cluster. (title: Redis Enterprise cluster properties)
sku	object	The resource model definition representing SKU
tags	object	Resource tags.
zones	array	The Availability Zones where this cluster will be deployed.

list_by_resource_group

The list of Redis Enterprise clusters

Name	Datatype	Description
identity	object	The identity of the resource.
location	string	The geo-location where the resource lives
properties	object	Other properties of the cluster. (title: Redis Enterprise cluster properties)
sku	object	The resource model definition representing SKU
tags	object	Resource tags.
zones	array	The Availability Zones where this cluster will be deployed.

list

The list of Redis Enterprise clusters

Name	Datatype	Description
identity	object	The identity of the resource.
location	string	The geo-location where the resource lives
properties	object	Other properties of the cluster. (title: Redis Enterprise cluster properties)
sku	object	The resource model definition representing SKU
tags	object	Resource tags.
zones	array	The Availability Zones where this cluster will be deployed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, clusterName, subscriptionId		Gets information about a Redis Enterprise cluster
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all Redis Enterprise clusters in a resource group.
list	select	subscriptionId		Lists all Redis Enterprise clusters in the specified subscription.
create	insert	resourceGroupName, clusterName, subscriptionId, data__sku		Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
update	update	resourceGroupName, clusterName, subscriptionId		Updates an existing Redis Enterprise cluster
delete	delete	resourceGroupName, clusterName, subscriptionId		Deletes a Redis Enterprise cache 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
clusterName	string	The name of the Redis Enterprise cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about a Redis Enterprise cluster

SELECT
identity,
location,
properties,
sku,
tags,
zones
FROM azure_isv.redis_enterprise.redis_enterprises
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all Redis Enterprise clusters in a resource group.

SELECT
identity,
location,
properties,
sku,
tags,
zones
FROM azure_isv.redis_enterprise.redis_enterprises
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all Redis Enterprise clusters in the specified subscription.

SELECT
identity,
location,
properties,
sku,
tags,
zones
FROM azure_isv.redis_enterprise.redis_enterprises
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

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

INSERT INTO azure_isv.redis_enterprise.redis_enterprises (
data__sku,
data__zones,
data__identity,
data__properties,
data__tags,
data__location,
resourceGroupName,
clusterName,
subscriptionId
)
SELECT 
'{{ sku }}' /* required */,
'{{ zones }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ subscriptionId }}'
RETURNING
identity,
location,
properties,
sku,
tags,
zones
;

Manifest

# Description fields are for documentation purposes
- name: redis_enterprises
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the redis_enterprises resource.
    - name: clusterName
      value: string
      description: Required parameter for the redis_enterprises resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the redis_enterprises resource.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: zones
      value: array
      description: |
        The Availability Zones where this cluster will be deployed.
    - name: identity
      value: object
      description: |
        The identity of the resource.
    - name: properties
      value: object
      description: |
        Other properties of the cluster.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates an existing Redis Enterprise cluster

UPDATE azure_isv.redis_enterprise.redis_enterprises
SET 
data__sku = '{{ sku }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
location,
properties,
sku,
tags,
zones;

DELETE examples

delete

Deletes a Redis Enterprise cache cluster.

DELETE FROM azure_isv.redis_enterprise.redis_enterprises
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;