az synapse integration-runtime-node

Manage Synapse's self-hosted integration runtime nodes.

Commands

Name	Description	Type	Status
az synapse integration-runtime-node delete	Remove a self-hosted integration runtime node.	Core	GA
az synapse integration-runtime-node get-ip-address	Get self-hosted integration runtime node ip.	Core	GA
az synapse integration-runtime-node show	Get self-hosted integration runtime node information.	Core	GA
az synapse integration-runtime-node update	Update self-hosted integration runtime node.	Core	GA

az synapse integration-runtime-node delete

Edit

Remove a self-hosted integration runtime node.

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

Examples

Remove a self-hosted integration runtime node.

az synapse integration-runtime-node delete --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime --node-name testnode

Required Parameters

--node-name

The integration runtime node name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The integration runtime name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az synapse integration-runtime-node get-ip-address

Edit

Get self-hosted integration runtime node ip.

az synapse integration-runtime-node get-ip-address --node-name
                                                   [--ids]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--workspace-name]

Examples

Get self-hosted integration runtime node ip.

az synapse integration-runtime-node get-ip-address --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime --node-name testnode

Required Parameters

--node-name

The integration runtime node name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The integration runtime name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az synapse integration-runtime-node show

Edit

Get self-hosted integration runtime node information.

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

Examples

Get self-hosted integration runtime node information.

az synapse integration-runtime-node show --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime --node-name testnode

Required Parameters

--node-name

The integration runtime node name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The integration runtime name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az synapse integration-runtime-node update

Edit

Update self-hosted integration runtime node.

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

Examples

Update self-hosted integration runtime node.

az synapse integration-runtime-node update --workspace-name testsynapseworkspace --resource-group rg \
  --name selfhostedintegrationruntime --node-name testnode --auto-update On --update-delay-offset 'PT03H'

Required Parameters

--auto-update

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

Property	Value
Accepted values:	Off, On

--node-name

The integration runtime node name.

--update-delay-offset

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The integration runtime name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

The workspace name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False