az stack-hci extension

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

Manage extension with stack hci.

Commands

Name Description Type Status
az stack-hci extension create

Create extension for HCI cluster.

 Extension GA
az stack-hci extension delete

Delete particular arc extension of HCI Cluster.

 Extension GA
az stack-hci extension list

List all extensions under arc setting resource.

 Extension GA
az stack-hci extension show

Get particular arc extension of HCI cluster.

 Extension GA
az stack-hci extension wait

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

 Extension GA

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 {0, 1, f, false, n, no, t, true, y, yes}]
                              [--force-update-tag]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--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 '{"workspaceId": "xx", "port": "6516"}' --publisher "Microsoft.Compute" --settings '{"workspaceKey": "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: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

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

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

Protected settings (may contain secrets). Support json-file and yaml-file.

--publisher

The name of the extension handler publisher.

--settings

Json formatted public settings for the extension. Support json-file and yaml-file.

--type

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

--type-handler-version

Specifies the version of the script handler. Latest version would be used if not specified.

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

Delete particular arc extension of HCI Cluster.

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

Examples

Delete arc extension

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

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

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

List all extensions under arc setting resource.

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

Examples

List extensions under arc setting 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>.

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

Get particular arc extension of HCI cluster.

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

Examples

Get arc settings extension

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

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

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

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

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

Optional Parameters

--arc-setting-name

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

The name of the machine extension.

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