az synapse integration-runtime

Manage Synapse's integration runtimes.

Commands

Name	Description	Type	Status
az synapse integration-runtime create	Create an integration runtime.	Core	Deprecated
az synapse integration-runtime delete	Delete an integration runtime.	Core	GA
az synapse integration-runtime get-connection-info	Get the integration runtime connection infomation.	Core	GA
az synapse integration-runtime get-monitoring-data	Get metric data for a self-hosted integration runtime.	Core	GA
az synapse integration-runtime get-status	Gets detailed status information for an integration runtime.	Core	GA
az synapse integration-runtime list	List integration runtimes.	Core	GA
az synapse integration-runtime list-auth-key	Get keys for a self-hosted integration runtime.	Core	GA
az synapse integration-runtime managed	Manage integration runtime with synapse sub group managed.	Core	GA
az synapse integration-runtime managed create	Create an managed integration runtime.	Core	GA
az synapse integration-runtime regenerate-auth-key	Regenerate self-hosted integration runtime key.	Core	GA
az synapse integration-runtime self-hosted	Manage integration runtime with synapse sub group self-hosted.	Core	GA
az synapse integration-runtime self-hosted create	Create an self-hosted integration runtime.	Core	GA
az synapse integration-runtime show	Get an integration runtime.	Core	GA
az synapse integration-runtime start	Start an SSIS integration runtime.	Core	GA
az synapse integration-runtime stop	Stop an SSIS integration runtime.	Core	GA
az synapse integration-runtime sync-credentials	Synchronize credentials among integration runtime nodes.	Core	GA
az synapse integration-runtime update	Update an integration runtime.	Core	GA
az synapse integration-runtime upgrade	Upgrade self-hosted integration runtime.	Core	GA
az synapse integration-runtime wait	Place the CLI in a waiting state until a condition of a integration runtime is met.	Core	GA

az synapse integration-runtime create

Deprecated

This command has been deprecated and will be removed in a future release. Use 'managed create， self-hosted create' instead.

Create an integration runtime.

az synapse integration-runtime create --name
                                      --resource-group
                                      --type {Managed, SelfHosted}
                                      --workspace-name
                                      [--compute-type {ComputeOptimized, General, MemoryOptimized}]
                                      [--core-count]
                                      [--description]
                                      [--if-match]
                                      [--location]
                                      [--no-wait]
                                      [--time-to-live]

Examples

Create an integration runtime.

az synapse integration-runtime create --workspace-name testsynapseworkspace --resource-group rg \
  --name testintegrationruntime --type Managed

Required Parameters

--name -n

The integration runtime name.

--resource-group -g

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

--type

The integration runtime type.

Accepted values: Managed, SelfHosted

--workspace-name

The workspace name.

Optional Parameters

--compute-type

Compute type of the data flow cluster which will execute data flow job.

Accepted values: ComputeOptimized, General, MemoryOptimized

Default value: General

--core-count

Core count of the data flow cluster which will execute data flow job.

Default value: 8

--description

The integration runtime description.

--if-match

ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

--location -l

The integration runtime location.

Default value: AutoResolve

--no-wait

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

Default value: False

--time-to-live

Time to live (in minutes) setting of the data flow cluster which will execute data flow job.

Default value: 0

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 synapse integration-runtime delete

Delete an integration runtime.

az synapse integration-runtime delete [--ids]
                                      [--name]
                                      [--no-wait]
                                      [--resource-group]
                                      [--subscription]
                                      [--workspace-name]
                                      [--yes]

Examples

Delete an integration runtime.

az synapse integration-runtime delete --workspace-name testsynapseworkspace --resource-group rg \
  --name testintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace name.

--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 synapse integration-runtime get-connection-info

Get the integration runtime connection infomation.

az synapse integration-runtime get-connection-info [--ids]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--workspace-name]

Examples

Get the integration runtime connection infomation.

az synapse integration-runtime get-connection-info --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime get-monitoring-data

Get metric data for a self-hosted integration runtime.

az synapse integration-runtime get-monitoring-data [--ids]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--workspace-name]

Examples

Get metric data for a self-hosted integration runtime.

az synapse integration-runtime get-monitoring-data --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime get-status

Gets detailed status information for an integration runtime.

az synapse integration-runtime get-status [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]
                                          [--workspace-name]

Examples

Gets detailed status information for an integration runtime.

az synapse integration-runtime get-status --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime list

List integration runtimes.

az synapse integration-runtime list --resource-group
                                    --workspace-name

Examples

List integration runtimes.

az synapse integration-runtime list --workspace-name testsynapseworkspace --resource-group rg

Required Parameters

--resource-group -g

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

--workspace-name

The workspace 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 synapse integration-runtime list-auth-key

Get keys for a self-hosted integration runtime.

az synapse integration-runtime list-auth-key --name
                                             --resource-group
                                             --workspace-name

Examples

Get keys for a self-hosted integration runtime.

az synapse integration-runtime list-auth-key --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime

Required Parameters

--name -n

The integration runtime name.

--resource-group -g

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

--workspace-name

The workspace 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 synapse integration-runtime regenerate-auth-key

Regenerate self-hosted integration runtime key.

az synapse integration-runtime regenerate-auth-key [--ids]
                                                   [--key-name {authKey1, authKey2}]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--workspace-name]

Examples

Regenerate self-hosted integration runtime key.

az synapse integration-runtime regenerate-auth-key --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime --key-name authKey1

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.

--key-name

The name of the authentication key to regenerate.

Accepted values: authKey1, authKey2

Default value: default

--name -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime show

Get an integration runtime.

az synapse integration-runtime show [--ids]
                                    [--if-none-match]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]
                                    [--workspace-name]

Examples

Get an integration runtime.

az synapse integration-runtime show --workspace-name testsynapseworkspace --resource-group rg \
  --name testintegrationruntime

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.

--if-none-match

ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

--name -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime start

Start an SSIS integration runtime.

az synapse integration-runtime start [--ids]
                                     [--name]
                                     [--no-wait]
                                     [--resource-group]
                                     [--subscription]
                                     [--workspace-name]

Examples

start an SSIS integration runtime.

az synapse integration-runtime start --workspace-name testsynapseworkspace --resource-group rg \
  --name testintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime stop

Stop an SSIS integration runtime.

az synapse integration-runtime stop [--ids]
                                    [--name]
                                    [--no-wait]
                                    [--resource-group]
                                    [--subscription]
                                    [--workspace-name]
                                    [--yes]

Examples

stop an SSIS integration runtime.

az synapse integration-runtime stop --workspace-name testsynapseworkspace --resource-group rg \
  --name testintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace name.

--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 synapse integration-runtime sync-credentials

Synchronize credentials among integration runtime nodes.

az synapse integration-runtime sync-credentials [--ids]
                                                [--name]
                                                [--resource-group]
                                                [--subscription]
                                                [--workspace-name]

Examples

Synchronize credentials among integration runtime nodes.

az synapse integration-runtime sync-credentials --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime update

Update an integration runtime.

az synapse integration-runtime update --auto-update {Off, On}
                                      --update-delay-offset
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]
                                      [--workspace-name]

Examples

Update an integration runtime.

az synapse integration-runtime update --workspace-name testsynapseworkspace --resource-group rg \
  --name testintegrationruntime --auto-update On --update-delay-offset '"PT03H"'

Required Parameters

--auto-update

Enable or disable the self-hosted integration runtime auto-update.

Accepted values: Off, On

--update-delay-offset

The time of the day for the self-hosted integration runtime auto-update.

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime upgrade

Upgrade self-hosted integration runtime.

az synapse integration-runtime upgrade [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--workspace-name]

Examples

Upgrade self-hosted integration runtime.

az synapse integration-runtime upgrade --workspace-name testsynapseworkspace --resource-group rg \
  --name testintegrationruntime

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 -n

The integration runtime name.

--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.

--workspace-name

The workspace 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 synapse integration-runtime wait

Place the CLI in a waiting state until a condition of a integration runtime is met.

az synapse integration-runtime wait --name
                                    --resource-group
                                    --workspace-name
                                    [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--if-none-match]
                                    [--interval]
                                    [--timeout]
                                    [--updated]

Required Parameters

--name -n

The integration runtime name.

--resource-group -g

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

--workspace-name

The workspace name.

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

--if-none-match

ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

--interval

Polling interval in seconds.

Default value: 30

--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.