Share via

az arcgateway

  • Reference

Note

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

Manage gateway connection on Arc machine.

Commands

Name Description Type Status
az arcgateway create

Create an Arc gateway resource.

 Extension GA
az arcgateway delete

Delete an Arc gateway resource.

 Extension GA
az arcgateway list

List all Arc gateway resources associated with a specific subscription.

 Extension GA
az arcgateway settings

Manage Settings for Azure Arc-Enabled Server.

 Extension GA
az arcgateway settings update

Update the base Settings of the target resource.

 Extension GA
az arcgateway show

Show the details of a specific Arc gateway resource.

 Extension GA
az arcgateway wait

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

 Extension GA

az arcgateway create

Create an Arc gateway resource.

az arcgateway create --gateway-name
                     --resource-group
                     [--allowed-features]
                     [--gateway-type {Public}]
                     [--location]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--tags]

Examples

Sample command for gateway create

az arcgateway create --name MyArcgateway --resource-group myResourceGroup --location eastus2euap --subscription mySubscription

Required Parameters

--gateway-name --name -n

The name of the Gateway.

--resource-group -g

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

Optional Parameters

--allowed-features

Specifies the list of features that are enabled for this Gateway. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Default value: ['*']
--gateway-type

The type of the Gateway resource.

Accepted values: Public
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 arcgateway delete

Delete an Arc gateway resource.

az arcgateway delete [--gateway-name]
                     [--ids]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--resource-group]
                     [--subscription]
                     [--yes]

Examples

Sample command or gateway delete

az arcgateway delete --name MyArcgateway --resource-group myResourceGroup --subscription mySubscription

Optional Parameters

--gateway-name --name -n

The name of the Gateway.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 arcgateway list

List all Arc gateway resources associated with a specific subscription.

az arcgateway list [--max-items]
                   [--next-token]
                   [--resource-group]

Examples

Sample command or gateway list

az arcgateway list --subscription mySubscription

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--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 arcgateway show

Show the details of a specific Arc gateway resource.

az arcgateway show [--gateway-name]
                   [--ids]
                   [--resource-group]
                   [--subscription]

Examples

Sample command for gateway show

az arcgateway show --name myArcgateway --resource-group myResourceGroup --subscription mySubscription

Optional Parameters

--gateway-name --name -n

The name of the Gateway.

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

--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 arcgateway wait

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

az arcgateway wait [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--gateway-name]
                   [--ids]
                   [--interval]
                   [--resource-group]
                   [--subscription]
                   [--timeout]
                   [--updated]

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

The name of the Gateway.

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