az stack-hci arc-setting

  • Reference

Note

This reference is part of the stack-hci extension for the Azure CLI (version 2.54.0 or higher). The extension will automatically install the first time you run an az stack-hci arc-setting command. Learn more about extensions.

Manage arc setting with stack hci.

Commands

Name Description Type Status
az stack-hci arc-setting consent-and-install-default-extension

Add consent time for default extensions and initiate extensions installation.

 Extension GA
az stack-hci arc-setting create

Create arc setting for HCI cluster.

 Extension GA
az stack-hci arc-setting create-identity

Create AAD identity for arc settings.

 Extension GA
az stack-hci arc-setting delete

Delete arc setting resource details of HCI cluster.

 Extension GA
az stack-hci arc-setting generate-password

Generate password for arc settings.

 Extension GA
az stack-hci arc-setting initialize-disable-proces

Initialize ARC Disable process on the cluster.

 Extension GA
az stack-hci arc-setting list

List arc setting resources of HCI cluster.

 Extension GA
az stack-hci arc-setting show

Get arc setting resource details of HCI cluster.

 Extension GA
az stack-hci arc-setting update

Update arc setting for HCI cluster.

 Extension GA
az stack-hci arc-setting wait

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

 Extension GA

Add consent time for default extensions and initiate extensions installation.

az stack-hci arc-setting consent-and-install-default-extension [--arc-setting-name]
                                                               [--cluster-name]
                                                               [--ids]
                                                               [--resource-group]
                                                               [--subscription]

Consent and install default extension

az stack-hci arc-setting consent-and-install-default-extension -g rg --arc-setting-name default --cluster-name name
--arc-setting-name

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

--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 stack-hci arc-setting create

Create arc setting for HCI cluster.

az stack-hci arc-setting create --arc-setting-name
                                --cluster-name
                                --resource-group
                                [--arc-application-client-id]
                                [--arc-application-object-id]
                                [--arc-application-tenant-id]
                                [--arc-instance-rg]
                                [--arc-service-principal-object-id]
                                [--connectivity-properties]

Examples

Create arc setting

az stack-hci arc-setting create --name "default" --cluster-name "myCluster" --resource-group "test-rg"

Required Parameters

--arc-setting-name --name -n

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

--resource-group -g

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

Optional Parameters

--arc-application-client-id

App id of arc AAD identity.

--arc-application-object-id

Object id of arc AAD identity.

--arc-application-tenant-id

Tenant id of arc AAD identity.

--arc-instance-rg

The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.

--arc-service-principal-object-id

Object id of arc AAD service principal.

--connectivity-properties

Contains connectivity related configuration for ARC resources 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 stack-hci arc-setting create-identity

Create AAD identity for arc settings.

az stack-hci arc-setting create-identity [--arc-setting-name]
                                         [--cluster-name]
                                         [--ids]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]

Examples

Create arc identity

az stack-hci arc-setting create-identity --name "default" --cluster-name "myCluster" --resource-group "test-rg"

Optional Parameters

--arc-setting-name --name -n

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

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

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 stack-hci arc-setting delete

Delete arc setting resource details of HCI cluster.

az stack-hci arc-setting delete [--arc-setting-name]
                                [--cluster-name]
                                [--ids]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--resource-group]
                                [--subscription]
                                [--yes]

Examples

Delete arc setting

az stack-hci arc-setting delete --name "default" --cluster-name "myCluster" --resource-group "test-rg"

Optional Parameters

--arc-setting-name --name -n

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

--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 stack-hci arc-setting generate-password

Generate password for arc settings.

az stack-hci arc-setting generate-password [--arc-setting-name]
                                           [--cluster-name]
                                           [--ids]
                                           [--resource-group]
                                           [--subscription]

Examples

Generate password

az stack-hci arc-setting generate-password --name "default" --cluster-name "myCluster" --resource-group "test-rg"

Optional Parameters

--arc-setting-name --name -n

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

--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 stack-hci arc-setting initialize-disable-proces

Initialize ARC Disable process on the cluster.

az stack-hci arc-setting initialize-disable-proces [--arc-setting-name]
                                                   [--cluster-name]
                                                   [--ids]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Initialize disable proces

az stack-hci arc-setting initialize-disable-proces -g rg --arc-setting-name default --cluster-name name

Optional Parameters

--arc-setting-name

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

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

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 stack-hci arc-setting list

List arc setting resources of HCI cluster.

az stack-hci arc-setting list --cluster-name
                              --resource-group
                              [--max-items]
                              [--next-token]

Examples

List arc setting resources by HCI cluster

az stack-hci arc-setting list --cluster-name "myCluster" --resource-group "test-rg"

Required Parameters

--cluster-name

The name of the cluster.

--resource-group -g

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

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.

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 stack-hci arc-setting show

Get arc setting resource details of HCI cluster.

az stack-hci arc-setting show [--arc-setting-name]
                              [--cluster-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

Examples

Get arc setting

az stack-hci arc-setting show --name "default" --cluster-name "myCluster" --resource-group "test-rg"

Optional Parameters

--arc-setting-name --name -n

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

--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 stack-hci arc-setting update

Update arc setting for HCI cluster.

az stack-hci arc-setting update [--add]
                                [--arc-setting-name]
                                [--cluster-name]
                                [--connectivity-properties]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]

Examples

Update arc setting

az stack-hci arc-setting update --resource-group "test-rg" --cluster-name "myCluster" --name "default" --tags "{tag:tag}"

Optional Parameters

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

--arc-setting-name --name -n

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

--connectivity-properties

Contains connectivity related configuration for ARC resources Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

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

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

--remove

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

--resource-group -g

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

--set

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

--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 stack-hci arc-setting wait

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

az stack-hci arc-setting wait [--arc-setting-name]
                              [--cluster-name]
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--resource-group]
                              [--subscription]
                              [--timeout]
                              [--updated]

Optional Parameters

--arc-setting-name --name -n

The name of the proxy resource holding details of HCI ArcSetting information.

--cluster-name

The name of the cluster.

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