az stack-hci arc-setting

Note

This reference is part of the stack-hci extension for the Azure CLI (version 2.15.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

az stack-hci arc-setting create	Create ArcSetting for HCI cluster.
az stack-hci arc-setting create-identity	Create Aad identity for arc settings.
az stack-hci arc-setting delete	Delete ArcSetting resource details of HCI Cluster.
az stack-hci arc-setting generate-password	Generate password for arc settings.
az stack-hci arc-setting list	Get ArcSetting resources of HCI Cluster.
az stack-hci arc-setting show	Get ArcSetting resource details of HCI Cluster.
az stack-hci arc-setting update	Update ArcSettings for HCI cluster.
az stack-hci arc-setting wait	Place the CLI in a waiting state until a condition of the stack-hci arc-setting is met.

az stack-hci arc-setting create

Create ArcSetting 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-service-principal-object-id]
                                [--connectivity-properties]
                                [--created-at]
                                [--created-by]
                                [--created-by-type {Application, Key, ManagedIdentity, User}]
                                [--instance-rg]
                                [--last-modified-at]
                                [--last-modified-by]
                                [--last-modified-by-type {Application, Key, ManagedIdentity, User}]

Examples

Create ArcSetting

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-service-principal-object-id

Object id of arc AAD service principal.

--connectivity-properties

Contains connectivity related configuration for ARC resources Expected value: json-string/json-file/@json-file.

--created-at

The timestamp of resource creation (UTC).

--created-by

The identity that created the resource.

--created-by-type

The type of identity that created the resource.

accepted values: Application, Key, ManagedIdentity, User

--instance-rg

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

--last-modified-at

The timestamp of resource last modification (UTC).

--last-modified-by

The identity that last modified the resource.

--last-modified-by-type

The type of identity that last modified the resource.

accepted values: Application, Key, ManagedIdentity, User

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.

--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
                                         --resource-group
                                         [--no-wait]

Examples

Create Arc Identity

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

--no-wait

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

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.

--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 ArcSetting resource details of HCI Cluster.

az stack-hci arc-setting delete --arc-setting-name
                                --cluster-name
                                --resource-group
                                [--no-wait]
                                [--yes]

Examples

Delete ArcSetting

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

--no-wait

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

--yes -y

Do not prompt for confirmation.

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.

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

Examples

Generate Password

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

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.

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

Get ArcSetting resources of HCI Cluster.

az stack-hci arc-setting list --cluster-name
                              --resource-group

Examples

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

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.

--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 ArcSetting resource details of HCI Cluster.

az stack-hci arc-setting show --arc-setting-name
                              --cluster-name
                              --resource-group

Examples

Get ArcSetting

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

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.

--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 ArcSettings for HCI cluster.

az stack-hci arc-setting update --arc-setting-name
                                --cluster-name
                                --resource-group
                                [--connectivity-properties]
                                [--tags]

Examples

Patch ArcSetting

az stack-hci arc-setting update --connectivity-properties "{\"enabled\":true}" --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

--connectivity-properties

Contains connectivity related configuration for ARC resources Expected value: json-string/json-file/@json-file.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

--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 of the stack-hci arc-setting is met.

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

Examples

Pause executing next line of CLI script until the stack-hci arc-setting is successfully deleted.

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

Pause executing next line of CLI script until the stack-hci arc-setting is successfully created.

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

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

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

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

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