az arcgateway settings

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 settings command. Learn more about extensions.

Manage Settings for Azure Arc-Enabled Server.

Commands

Name	Description	Type	Status
az arcgateway settings update	Update the base Settings of the target resource.	Extension	GA

az arcgateway settings update

Update the base Settings of the target resource.

az arcgateway settings update [--add]
                              [--base-provider]
                              [--base-resource-name]
                              [--base-resource-type]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--gateway-resource-id]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]

Examples

Sample command for setting update

az az arcgateway settings update --resource-group myResourceGroup --subscription mySubscription --base-provider Microsoft.HybridCompute --base-resource-type machines --base-resource-name workloadServer --gateway-resource-id myResourceId

Optional Parameters

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--base-provider

The name of the base Resource Provider.

Property	Value
Parameter group:	Resource Id Arguments

--base-resource-name

The name of the base resource.

Property	Value
Parameter group:	Resource Id Arguments

--base-resource-type

The name of the base Resource Type.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--gateway-resource-id

Associated Gateway Resource Id.

Property	Value
Parameter group:	GatewayProperties Arguments

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

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update 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

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