az stack-hci extension

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

Manage extension with stack hci.

Commands

az stack-hci extension create	Create Extension for HCI cluster.
az stack-hci extension delete	Delete particular Arc Extension of HCI Cluster.
az stack-hci extension list	List all Extensions under ArcSetting resource.
az stack-hci extension show	Get particular Arc Extension of HCI Cluster.
az stack-hci extension wait	Place the CLI in a waiting state until a condition of the stack-hci extension is met.

az stack-hci extension create

Create Extension for HCI cluster.

az stack-hci extension create --arc-setting-name
                              --cluster-name
                              --extension-name
                              --resource-group
                              [--auto-upgrade {false, true}]
                              [--created-at]
                              [--created-by]
                              [--created-by-type {Application, Key, ManagedIdentity, User}]
                              [--force-update-tag]
                              [--last-modified-at]
                              [--last-modified-by]
                              [--last-modified-by-type {Application, Key, ManagedIdentity, User}]
                              [--no-wait]
                              [--protected-settings]
                              [--publisher]
                              [--settings]
                              [--type]
                              [--type-handler-version]

Examples

Create Arc Extension

az stack-hci extension create --arc-setting-name "default" --cluster-name "myCluster" --type "MicrosoftMonitoringAgent" --protected-settings "{\"workspaceKey\":\"xx\"}" --publisher "Microsoft.Compute" --settings "{\"workspaceId\":\"xx\"}" --type-handler-version "1.10" --name "MicrosoftMonitoringAgent" --resource-group "test-rg"

Required Parameters

--arc-setting-name

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

--cluster-name

The name of the cluster.

--extension-name --name -n

The name of the machine extension.

--resource-group -g

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

Optional Parameters

--auto-upgrade

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

accepted values: false, true

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

--force-update-tag

How the extension handler should be forced to update even if the extension configuration has not changed.

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

--no-wait

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

--protected-settings

Protected settings (may contain secrets). Expected value: json-string/json-file/@json-file.

--publisher

The name of the extension handler publisher.

--settings

Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file.

--type

Specifies the type of the extension; an example is "CustomScriptExtension".

--type-handler-version

Specifies the version of the script handler.

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

Delete particular Arc Extension of HCI Cluster.

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

Examples

Delete Arc Extension

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

Required Parameters

--arc-setting-name

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

--cluster-name

The name of the cluster.

--extension-name --name -n

The name of the machine extension.

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

List all Extensions under ArcSetting resource.

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

Examples

List Extensions under ArcSetting resource

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

Required Parameters

--arc-setting-name

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

Get particular Arc Extension of HCI Cluster.

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

Examples

Get ArcSettings Extension

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

Required Parameters

--arc-setting-name

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

--cluster-name

The name of the cluster.

--extension-name --name -n

The name of the machine extension.

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

Place the CLI in a waiting state until a condition of the stack-hci extension is met.

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

Examples

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

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

Pause executing next line of CLI script until the stack-hci extension is successfully updated.

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

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

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

Required Parameters

--arc-setting-name

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

--cluster-name

The name of the cluster.

--extension-name --name -n

The name of the machine extension.

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