redis

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

Overview

Name	redis
Type	Resource
Id	azure_isv.redis.redis

Fields

vw_redis

Name	Datatype	Description
name	text	field from the properties object
access_keys	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)
instances	text	field from the properties object
linked_servers	text	field from the properties object
location	text	The geo-location where the resource lives
port	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	field from the properties object
ssl_port	text	field from the properties object
static_ip	text	field from the properties object
subnet_id	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
zones	text	A list of availability zones denoting where the resource needs to come from.

redis

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 the redis cache.
tags	object	Resource tags.
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	name, resourceGroupName, subscriptionId	Gets a Redis cache (resource description).
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all Redis caches in a resource group.
list_by_subscription	SELECT	subscriptionId	Gets all Redis caches in the specified subscription.
create	INSERT	name, resourceGroupName, subscriptionId, data__location, data__properties	Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.
delete	DELETE	name, resourceGroupName, subscriptionId	Deletes a Redis cache.
update	UPDATE	name, resourceGroupName, subscriptionId	Update an existing Redis cache.
check_name_availability	EXEC	subscriptionId, data__name, data__type	Checks that the redis cache name is valid and is not already in use.
export_data	EXEC	name, resourceGroupName, subscriptionId, data__container, data__prefix	Export data from the redis cache to blobs in a container.
flush_cache	EXEC	cacheName, resourceGroupName, subscriptionId	Deletes all of the keys in a cache.
force_reboot	EXEC	name, resourceGroupName, subscriptionId	Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.
import_data	EXEC	name, resourceGroupName, subscriptionId, data__files	Import data into Redis cache.
regenerate_key	EXEC	name, resourceGroupName, subscriptionId, data__keyType	Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.

SELECT examples

Gets all Redis caches in the specified subscription.

vw_redis

SELECT
name,
access_keys,
host_name,
identity,
instances,
linked_servers,
location,
port,
private_endpoint_connections,
provisioning_state,
resourceGroupName,
sku,
ssl_port,
static_ip,
subnet_id,
subscriptionId,
tags,
zones
FROM azure_isv.redis.vw_redis
WHERE subscriptionId = '{{ subscriptionId }}';

redis

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure_isv.redis.redis (
name,
resourceGroupName,
subscriptionId,
data__location,
data__properties,
properties,
zones,
location,
tags,
identity
)
SELECT 
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ properties }}',
'{{ zones }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: sku
          value:
            - name: name
              value: string
            - name: family
              value: string
            - name: capacity
              value: integer
        - name: subnetId
          value: string
        - name: staticIP
          value: string
        - name: redisConfiguration
          value:
            - name: rdb-backup-enabled
              value: string
            - name: rdb-backup-frequency
              value: string
            - name: rdb-backup-max-snapshot-count
              value: string
            - name: rdb-storage-connection-string
              value: string
            - name: aof-backup-enabled
              value: string
            - name: aof-storage-connection-string-0
              value: string
            - name: aof-storage-connection-string-1
              value: string
            - name: maxfragmentationmemory-reserved
              value: string
            - name: maxmemory-policy
              value: string
            - name: maxmemory-reserved
              value: string
            - name: maxmemory-delta
              value: string
            - name: maxclients
              value: string
            - name: notify-keyspace-events
              value: string
            - name: preferred-data-archive-auth-method
              value: string
            - name: preferred-data-persistence-auth-method
              value: string
            - name: zonal-configuration
              value: string
            - name: authnotrequired
              value: string
            - name: storage-subscription-id
              value: string
            - name: aad-enabled
              value: string
        - name: redisVersion
          value: string
        - name: enableNonSslPort
          value: boolean
        - name: replicasPerMaster
          value: integer
        - name: replicasPerPrimary
          value: integer
        - name: tenantSettings
          value: object
        - name: shardCount
          value: integer
        - name: minimumTlsVersion
          value: string
        - name: publicNetworkAccess
          value: string
        - name: updateChannel
          value: string
        - name: disableAccessKeyAuthentication
          value: boolean
        - name: zonalAllocationPolicy
          value: string
    - name: zones
      value:
        - string
    - name: location
      value: string
    - name: tags
      value: object
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []

UPDATE example

Updates a redis resource.

/*+ update */
UPDATE azure_isv.redis.redis
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified redis resource.

/*+ delete */
DELETE FROM azure_isv.redis.redis
WHERE name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';