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

Successfully retrieved Migration Config)

Name	Datatype	Description
properties		Properties required to the Create Migration Configuration
systemData	object	The system meta data relating to this resource.

list

Successfully retrieved the list of migrationConfigurations for servicebus namespace

Name	Datatype	Description
properties		Properties required to the Create Migration Configuration
systemData	object	The system meta data relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, configName, subscriptionId		Retrieves Migration Config
list	select	resourceGroupName, namespaceName, subscriptionId		Gets all migrationConfigurations
create_and_start_migration	insert	resourceGroupName, namespaceName, configName, subscriptionId		Creates Migration configuration and starts migration of entities from Standard to Premium namespace
delete	delete	resourceGroupName, namespaceName, configName, subscriptionId		Deletes a MigrationConfiguration
complete_migration	exec	resourceGroupName, namespaceName, configName, subscriptionId		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	resourceGroupName, namespaceName, configName, subscriptionId		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
configName	string	The configuration name. Should always be "$default".
namespaceName	string	The namespace name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Retrieves Migration Config

SELECT
properties,
systemData
FROM azure.service_bus.migration_configs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND configName = '{{ configName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all migrationConfigurations

SELECT
properties,
systemData
FROM azure.service_bus.migration_configs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_and_start_migration

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

INSERT INTO azure.service_bus.migration_configs (
data__properties,
resourceGroupName,
namespaceName,
configName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ configName }}',
'{{ subscriptionId }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: migration_configs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the migration_configs resource.
    - name: namespaceName
      value: string
      description: Required parameter for the migration_configs resource.
    - name: configName
      value: string
      description: Required parameter for the migration_configs resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the migration_configs resource.
    - name: properties
      value: string
      description: |
        Properties required to the Create Migration Configuration

DELETE examples

delete

Deletes a MigrationConfiguration

DELETE FROM azure.service_bus.migration_configs
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND configName = '{{ configName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

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 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@configName='{{ configName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

revert

This operation reverts Migration

EXEC azure.service_bus.migration_configs.revert 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@configName='{{ configName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;