migration

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

Overview

Name	migration
Type	Resource
Id	azure_isv.redisenterprise.migration

Fields

The following fields are returned by SELECT queries:

get

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.
creationTime	string (date-time)	The timestamp when the migration operation was created.
lastModifiedTime	string (date-time)	The timestamp when the migration operation was last updated.
provisioningState	string	Current provisioning status of the migration. Known values are: "Accepted", "InProgress", "ReadyForDnsSwitch", "Succeeded", "Failed", "Cancelling", "Cancelled", and "CancellationFailed". (Accepted, InProgress, ReadyForDnsSwitch, Succeeded, Failed, Cancelling, Cancelled, CancellationFailed)
sourceType	string	Describes the source of the migration operation. Required. "AzureCacheForRedis"
statusDetails	string	Additional details about the migration operation's status in free text format.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetResourceId	string	The Azure resource ID of the Azure Managed Redis destination cache to migrate.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Gets information about a migration in a Redis Enterprise cluster.
start	exec	resource_group_name, cluster_name, subscription_id		Starts a new migration.
cancel	exec	resource_group_name, cluster_name, subscription_id		Cancel or rollback the migration operation in a Redis Enterprise cluster.
list_raw	exec	resource_group_name, cluster_name, subscription_id		Gets information about all migrations attempts in a 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

Gets information about a migration in a Redis Enterprise cluster.

SELECT
id,
name,
creationTime,
lastModifiedTime,
provisioningState,
sourceType,
statusDetails,
systemData,
targetResourceId,
type
FROM azure_isv.redisenterprise.migration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

start

Starts a new migration.

EXEC azure_isv.redisenterprise.migration.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

cancel

Cancel or rollback the migration operation in a Redis Enterprise cluster.

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

list_raw

Gets information about all migrations attempts in a Redis Enterprise cluster.

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