az datafactory integration-runtime

Datafactory integration-runtime.

Commands

az datafactory integration-runtime delete

Deletes an integration runtime.

az datafactory integration-runtime get-connection-info

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

az datafactory integration-runtime get-monitoring-data

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

az datafactory integration-runtime get-status

Gets detailed status information for an integration runtime.

az datafactory integration-runtime linked-integration-runtime

Datafactory integration-runtime sub group linked-integration-runtime.

az datafactory integration-runtime linked-integration-runtime create

Create a linked integration runtime entry in a shared integration runtime.

az datafactory integration-runtime list

Lists integration runtimes.

az datafactory integration-runtime list-auth-key

Retrieves the authentication keys for an integration runtime.

az datafactory integration-runtime managed

Datafactory integration-runtime sub group managed.

az datafactory integration-runtime managed create

Creates or updates an integration runtime.

az datafactory integration-runtime regenerate-auth-key

Regenerates the authentication key for an integration runtime.

az datafactory integration-runtime remove-link

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

az datafactory integration-runtime self-hosted

Datafactory integration-runtime sub group self-hosted.

az datafactory integration-runtime self-hosted create

Creates or updates an integration runtime.

az datafactory integration-runtime show

Gets an integration runtime.

az datafactory integration-runtime start

Starts a ManagedReserved type integration runtime.

az datafactory integration-runtime stop

Stops a ManagedReserved type integration runtime.

az datafactory integration-runtime sync-credentials

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

az datafactory integration-runtime update

Updates an integration runtime.

az datafactory integration-runtime upgrade

Upgrade self-hosted integration runtime to latest version if availability.

az datafactory integration-runtime wait

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

az datafactory integration-runtime delete

Deletes an integration runtime.

az datafactory integration-runtime delete --factory-name
                                          --name
                                          --resource-group

Examples

IntegrationRuntimes_Delete

az datafactory integration-runtime delete --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

az datafactory integration-runtime get-connection-info

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

az datafactory integration-runtime get-connection-info --factory-name
                                                       --name
                                                       --resource-group

Examples

IntegrationRuntimes_GetConnectionInfo

az datafactory integration-runtime get-connection-info --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

az datafactory integration-runtime get-monitoring-data

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

az datafactory integration-runtime get-monitoring-data --factory-name
                                                       --name
                                                       --resource-group

Examples

IntegrationRuntimes_GetMonitoringData

az datafactory integration-runtime get-monitoring-data --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

az datafactory integration-runtime get-status

Gets detailed status information for an integration runtime.

az datafactory integration-runtime get-status --factory-name
                                              --name
                                              --resource-group

Examples

IntegrationRuntimes_GetStatus

az datafactory integration-runtime get-status --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

az datafactory integration-runtime list

Lists integration runtimes.

az datafactory integration-runtime list --factory-name
                                        --resource-group

Examples

IntegrationRuntimes_ListByFactory

az datafactory integration-runtime list --factory-name "myFactoryName" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

--resource-group -g

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

az datafactory integration-runtime list-auth-key

Retrieves the authentication keys for an integration runtime.

az datafactory integration-runtime list-auth-key --factory-name
                                                 --name
                                                 --resource-group

Examples

IntegrationRuntimes_ListAuthKeys

az datafactory integration-runtime list-auth-key --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

az datafactory integration-runtime regenerate-auth-key

Regenerates the authentication key for an integration runtime.

az datafactory integration-runtime regenerate-auth-key --factory-name
                                                       --name
                                                       --resource-group
                                                       [--key-name {authKey1, authKey2}]

Examples

IntegrationRuntimes_RegenerateAuthKey

az datafactory integration-runtime regenerate-auth-key --factory-name "myFactoryName" --name "myIntegrationRuntime" --key-name "authKey2" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

Optional Parameters

--key-name

The name of the authentication key to regenerate.

accepted values: authKey1, authKey2

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

az datafactory integration-runtime remove-link --factory-name
                                               --linked-factory-name
                                               --name
                                               --resource-group

IntegrationRuntimes_Upgrade

az datafactory integration-runtime remove-link --factory-name "myFactoryName" --name "myIntegrationRuntime" --linked-factory-name "myFactoryName-linked" --resource-group "myResourceGroup"
--factory-name

The factory name.

--linked-factory-name

The data factory name for linked integration runtime.

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

az datafactory integration-runtime show

Gets an integration runtime.

az datafactory integration-runtime show --factory-name
                                        --name
                                        --resource-group
                                        [--if-none-match]

Examples

IntegrationRuntimes_Get

az datafactory integration-runtime show --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

Optional Parameters

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

az datafactory integration-runtime start

Starts a ManagedReserved type integration runtime.

az datafactory integration-runtime start --factory-name
                                         --name
                                         --resource-group
                                         [--no-wait]

Examples

IntegrationRuntimes_Start

az datafactory integration-runtime start --factory-name "myFactoryName" --name "myManagedIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

Optional Parameters

--no-wait

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

az datafactory integration-runtime stop

Stops a ManagedReserved type integration runtime.

az datafactory integration-runtime stop --factory-name
                                        --name
                                        --resource-group
                                        [--no-wait]

Examples

IntegrationRuntimes_Stop

az datafactory integration-runtime stop --factory-name "myFactoryName" --name "myManagedIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

Optional Parameters

--no-wait

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

az datafactory integration-runtime sync-credentials

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

az datafactory integration-runtime sync-credentials --factory-name
                                                    --name
                                                    --resource-group

Examples

IntegrationRuntimes_SyncCredentials

az datafactory integration-runtime sync-credentials --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

az datafactory integration-runtime update

Updates an integration runtime.

az datafactory integration-runtime update --factory-name
                                          --name
                                          --resource-group
                                          [--auto-update {Off, On}]
                                          [--update-delay-offset]

Examples

IntegrationRuntimes_Update

az datafactory integration-runtime update --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup" --auto-update "Off" --update-delay-offset "\"PT3H\""

Required Parameters

--factory-name

The factory name.

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

Optional Parameters

--auto-update

Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189.

accepted values: Off, On
--update-delay-offset

The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.

az datafactory integration-runtime upgrade

Upgrade self-hosted integration runtime to latest version if availability.

az datafactory integration-runtime upgrade --factory-name
                                           --name
                                           --resource-group

Examples

IntegrationRuntimes_Upgrade

az datafactory integration-runtime upgrade --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup"

Required Parameters

--factory-name

The factory name.

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

az datafactory integration-runtime wait

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

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

Examples

Pause executing next line of CLI script until the datafactory integration-runtime is successfully created.

az datafactory integration-runtime wait --factory-name "myFactoryName" --name "myIntegrationRuntime" --resource-group "myResourceGroup" --created

Required Parameters

--factory-name

The factory name.

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.