migration_configs

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

Overview

Name	migration_configs
Type	Resource
Id	azure.service_bus.migration_configs

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.
location	string	The geo-location where the resource lives.
migrationState	string	State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active.
pendingReplicationOperationsCount	integer	Number of entities pending to be replicated.
postMigrationName	string	Name to access Standard Namespace after migration.
provisioningState	string	Provisioning state of Migration Configuration.
systemData	object	The system meta data relating to this resource.
targetNamespace	string	Existing premium Namespace ARM Id name which has no entities, will be used for migration.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".

list

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.
location	string	The geo-location where the resource lives.
migrationState	string	State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active.
pendingReplicationOperationsCount	integer	Number of entities pending to be replicated.
postMigrationName	string	Name to access Standard Namespace after migration.
provisioningState	string	Provisioning state of Migration Configuration.
systemData	object	The system meta data relating to this resource.
targetNamespace	string	Existing premium Namespace ARM Id name which has no entities, will be used for migration.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, namespace_name, config_name, subscription_id		Retrieves Migration Config.
list	select	resource_group_name, namespace_name, subscription_id		Gets all migrationConfigurations.
delete	delete	resource_group_name, namespace_name, config_name, subscription_id		Deletes a MigrationConfiguration.
create_and_start_migration	exec	resource_group_name, namespace_name, config_name, subscription_id		Creates Migration configuration and starts migration of entities from Standard to Premium namespace.
complete_migration	exec	resource_group_name, namespace_name, config_name, subscription_id		This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.
revert	exec	resource_group_name, namespace_name, config_name, subscription_id		This operation reverts Migration.

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
config_name	string	The configuration name. Should always be "$default". "$default" Required.
namespace_name	string	The namespace name. Required.
resource_group_name	string	Name of the Resource group within the Azure subscription. Required.
subscription_id	string

SELECT examples

get

Retrieves Migration Config.

SELECT
id,
name,
location,
migrationState,
pendingReplicationOperationsCount,
postMigrationName,
provisioningState,
systemData,
targetNamespace,
type
FROM azure.service_bus.migration_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND config_name = '{{ config_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all migrationConfigurations.

SELECT
id,
name,
location,
migrationState,
pendingReplicationOperationsCount,
postMigrationName,
provisioningState,
systemData,
targetNamespace,
type
FROM azure.service_bus.migration_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Deletes a MigrationConfiguration.

DELETE FROM azure.service_bus.migration_configs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND config_name = '{{ config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

create_and_start_migration

Creates Migration configuration and starts migration of entities from Standard to Premium namespace.

EXEC azure.service_bus.migration_configs.create_and_start_migration 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@config_name='{{ config_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

complete_migration

This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.

EXEC azure.service_bus.migration_configs.complete_migration 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@config_name='{{ config_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

revert

This operation reverts Migration.

EXEC azure.service_bus.migration_configs.revert 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@config_name='{{ config_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;