databases

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

Overview

Name	databases
Type	Resource
Id	azure_isv.redis_enterprise.databases

Fields

The following fields are returned by SELECT queries:

get

Successfully found the database

Name	Datatype	Description
properties	object	Other properties of the database. (title: Redis Enterprise database properties)

list_by_cluster

The list of databases

Name	Datatype	Description
properties	object	Other properties of the database. (title: Redis Enterprise database properties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, clusterName, databaseName, subscriptionId		Gets information about a database in a Redis Enterprise cluster.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Gets all databases in the specified Redis Enterprise cluster.
create	insert	resourceGroupName, clusterName, databaseName, subscriptionId		Creates a database
update	update	resourceGroupName, clusterName, databaseName, subscriptionId		Updates a database
delete	delete	resourceGroupName, clusterName, databaseName, subscriptionId		Deletes a single database
regenerate_key	exec	resourceGroupName, clusterName, databaseName, subscriptionId, keyType		Regenerates the Redis Enterprise database's access keys.
import	exec	resourceGroupName, clusterName, databaseName, subscriptionId, sasUris		Imports database files to target database.
export	exec	resourceGroupName, clusterName, databaseName, subscriptionId, sasUri		Exports a database file from target database.
force_unlink	exec	resourceGroupName, clusterName, databaseName, subscriptionId, ids		Forcibly removes the link to the specified database resource.
force_link_to_replication_group	exec	resourceGroupName, clusterName, databaseName, subscriptionId, groupNickname, linkedDatabases		Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. IMPORTANT NOTE: All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.
flush	exec	resourceGroupName, clusterName, databaseName, subscriptionId		Flushes all the keys in this database and also from its linked databases.
upgrade_db_redis_version	exec	resourceGroupName, clusterName, databaseName, subscriptionId		Upgrades the database Redis version to the latest available.

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.
databaseName	string	The name of the Redis Enterprise database.
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 database in a Redis Enterprise cluster.

SELECT
properties
FROM azure_isv.redis_enterprise.databases
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_cluster

Gets all databases in the specified Redis Enterprise cluster.

SELECT
properties
FROM azure_isv.redis_enterprise.databases
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create

Creates a database

INSERT INTO azure_isv.redis_enterprise.databases (
data__properties,
resourceGroupName,
clusterName,
databaseName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ databaseName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: databases
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the databases resource.
    - name: clusterName
      value: string
      description: Required parameter for the databases resource.
    - name: databaseName
      value: string
      description: Required parameter for the databases resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the databases resource.
    - name: properties
      value: object
      description: |
        Other properties of the database.

UPDATE examples

update

Updates a database

UPDATE azure_isv.redis_enterprise.databases
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a single database

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

Lifecycle Methods

regenerate_key

Regenerates the Redis Enterprise database's access keys.

EXEC azure_isv.redis_enterprise.databases.regenerate_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;

import

Imports database files to target database.

EXEC azure_isv.redis_enterprise.databases.import 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sasUris": "{{ sasUris }}"
}'
;

export

Exports a database file from target database.

EXEC azure_isv.redis_enterprise.databases.export 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"sasUri": "{{ sasUri }}"
}'
;

force_unlink

Forcibly removes the link to the specified database resource.

EXEC azure_isv.redis_enterprise.databases.force_unlink 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"ids": "{{ ids }}"
}'
;

force_link_to_replication_group

Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. IMPORTANT NOTE: All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.

EXEC azure_isv.redis_enterprise.databases.force_link_to_replication_group 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"groupNickname": "{{ groupNickname }}", 
"linkedDatabases": "{{ linkedDatabases }}"
}'
;

flush

Flushes all the keys in this database and also from its linked databases.

EXEC azure_isv.redis_enterprise.databases.flush 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"ids": "{{ ids }}"
}'
;

upgrade_db_redis_version

Upgrades the database Redis version to the latest available.

EXEC azure_isv.redis_enterprise.databases.upgrade_db_redis_version 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@databaseName='{{ databaseName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;