az datamigration sql-service

  • Reference

Note

This reference is part of the datamigration extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az datamigration sql-service command. Learn more about extensions.

Manage Database Migration Service.

Commands

Name Description Type Status
az datamigration sql-service create

Create Database Migration Service.

 Extension GA
az datamigration sql-service delete

Delete Database Migration Service.

 Extension GA
az datamigration sql-service delete-node

Delete the integration runtime node.

 Extension GA
az datamigration sql-service list

Retrieve all Database Migration Services in the resource group. And Retrieve all Database Migration Services in the subscription.

 Extension GA
az datamigration sql-service list-auth-key

Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.

 Extension GA
az datamigration sql-service list-integration-runtime-metric

Retrieve the registered Integration Runtine nodes and their monitoring data for a given Database Migration Service.

 Extension GA
az datamigration sql-service list-migration

Retrieve the List of database migrations attached to the service.

 Extension GA
az datamigration sql-service regenerate-auth-key

Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.

 Extension GA
az datamigration sql-service show

Retrieve the Database Migration Service.

 Extension GA
az datamigration sql-service update

Update Database Migration Service.

 Extension GA
az datamigration sql-service wait

Place the CLI in a waiting state until a condition of the datamigration sql-service is met.

 Extension GA

az datamigration sql-service create

Create Database Migration Service.

az datamigration sql-service create --name
                                    --resource-group
                                    [--location]
                                    [--no-wait]
                                    [--tags]

Examples

Create or Update SQL Migration Service.

az datamigration sql-service create --location "northeurope" --resource-group "testrg" --name "testagent"

Required Parameters

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service delete

Delete Database Migration Service.

az datamigration sql-service delete [--ids]
                                    [--name]
                                    [--no-wait]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

Examples

Delete SQL Migration Service.

az datamigration sql-service delete --resource-group "testrg" --name "service1"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service delete-node

Delete the integration runtime node.

az datamigration sql-service delete-node [--ids]
                                         [--ir-name]
                                         [--name]
                                         [--node-name]
                                         [--resource-group]
                                         [--subscription]

Examples

Delete the integration runtime node.

az datamigration sql-service delete-node --ir-name "IRName" --node-name "nodeName" --resource-group "testrg" --name "service1"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--ir-name

The name of integration runtime.

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--node-name

The name of node to delete.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service list

Retrieve all Database Migration Services in the resource group. And Retrieve all Database Migration Services in the subscription.

az datamigration sql-service list [--resource-group]

Examples

Get Migration Services in the Resource Group.

az datamigration sql-service list --resource-group "testrg"

Get Services in the Subscriptions.

az datamigration sql-service list

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service list-auth-key

Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.

az datamigration sql-service list-auth-key --name
                                           --resource-group

Examples

Retrieve the List of Authentication Keys.

az datamigration sql-service list-auth-key --resource-group "testrg" --name "service1"

Required Parameters

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service list-integration-runtime-metric

Retrieve the registered Integration Runtine nodes and their monitoring data for a given Database Migration Service.

az datamigration sql-service list-integration-runtime-metric --name
                                                             --resource-group

Examples

Retrieve the Monitoring Data.

az datamigration sql-service list-integration-runtime-metric --resource-group "testrg" --name "service1"

Required Parameters

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service list-migration

Retrieve the List of database migrations attached to the service.

az datamigration sql-service list-migration --name
                                            --resource-group

Examples

List database migrations attached to the service.

az datamigration sql-service list-migration --resource-group "testrg" --name "service1"

Required Parameters

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service regenerate-auth-key

Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.

az datamigration sql-service regenerate-auth-key [--auth-key1]
                                                 [--auth-key2]
                                                 [--ids]
                                                 [--key-name]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]

Examples

Regenerate the of Authentication Keys.

az datamigration sql-service regenerate-auth-key --key-name "authKey1" --resource-group "testrg" --name "service1"

Optional Parameters

--auth-key1

The first authentication key.

--auth-key2

The second authentication key.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--key-name

The name of authentication key to generate.

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service show

Retrieve the Database Migration Service.

az datamigration sql-service show [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Get Migration Service.

az datamigration sql-service show --resource-group "testrg" --name "service1"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service update

Update Database Migration Service.

az datamigration sql-service update [--ids]
                                    [--name]
                                    [--no-wait]
                                    [--resource-group]
                                    [--subscription]
                                    [--tags]

Examples

Update SQL Migration Service.

az datamigration sql-service update --tags mytag="myval" --resource-group "testrg" --name "testagent"

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--no-wait

Do not wait for the long-running operation to finish.

default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datamigration sql-service wait

Place the CLI in a waiting state until a condition of the datamigration sql-service is met.

az datamigration sql-service wait [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--timeout]
                                  [--updated]

Examples

Pause executing next line of CLI script until the datamigration sql-service is successfully created.

az datamigration sql-service wait --resource-group "testrg" --name "service1" --created

Pause executing next line of CLI script until the datamigration sql-service is successfully updated.

az datamigration sql-service wait --resource-group "testrg" --name "service1" --updated

Pause executing next line of CLI script until the datamigration sql-service is successfully deleted.

az datamigration sql-service wait --resource-group "testrg" --name "service1" --deleted

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30
--name --sql-migration-service-name -n

Name of the SQL Migration Service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.