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

vw_redis_enterprises

Name	Datatype	Description
clusterName	text	field from the properties object
encryption	text	field from the properties object
high_availability	text	field from the properties object
host_name	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
location	text	The geo-location where the resource lives
minimum_tls_version	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
redis_version	text	field from the properties object
redundancy_mode	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_state	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
tags	text	Resource tags.
zones	text	The Availability Zones where this cluster will be deployed.

redis_enterprises

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the resource lives
properties	object	Properties of Redis Enterprise clusters, as opposed to general resource properties like location, tags
sku	object	The resource model definition representing SKU
tags	object	Resource tags.
zones	array	The Availability Zones where this cluster will be deployed.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Gets information about a Redis Enterprise cluster
list	SELECT	subscriptionId	Lists all Redis Enterprise clusters in the specified subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all Redis Enterprise clusters in a resource group.
create	INSERT	clusterName, resourceGroupName, subscriptionId, data__sku	Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Deletes a Redis Enterprise cache cluster.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Updates an existing Redis Enterprise cluster

SELECT examples

Lists all Redis Enterprise clusters in the specified subscription.

vw_redis_enterprises

SELECT
clusterName,
encryption,
high_availability,
host_name,
identity,
location,
minimum_tls_version,
private_endpoint_connections,
provisioning_state,
redis_version,
redundancy_mode,
resourceGroupName,
resource_state,
sku,
subscriptionId,
tags,
zones
FROM azure_isv.redis_enterprise.vw_redis_enterprises
WHERE subscriptionId = '{{ subscriptionId }}';

redis_enterprises

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

INSERT example

Use the following StackQL query and manifest file to create a new redis_enterprises resource.

All Properties

/*+ create */
INSERT INTO azure_isv.redis_enterprise.redis_enterprises (
clusterName,
resourceGroupName,
subscriptionId,
data__sku,
sku,
zones,
identity,
properties,
tags,
location
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__sku }}',
'{{ sku }}',
'{{ zones }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: []
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: zones
      value:
        - string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: properties
      value:
        - name: highAvailability
          value: string
        - name: minimumTlsVersion
          value: string
        - name: encryption
          value:
            - name: customerManagedKeyEncryption
              value:
                - name: keyEncryptionKeyIdentity
                  value:
                    - name: userAssignedIdentityResourceId
                      value: string
                    - name: identityType
                      value: string
                - name: keyEncryptionKeyUrl
                  value: string
        - name: hostName
          value: string
        - name: provisioningState
          value: []
        - name: redundancyMode
          value: string
        - name: resourceState
          value: []
        - name: redisVersion
          value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a redis_enterprises resource.

/*+ update */
UPDATE azure_isv.redis_enterprise.redis_enterprises
SET 
sku = '{{ sku }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
tags = '{{ tags }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified redis_enterprises resource.

/*+ delete */
DELETE FROM azure_isv.redis_enterprise.redis_enterprises
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';