Share via

az stack-hci extension

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

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

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

Property Value
Parameter group: ExtensionParameters Arguments
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.

Property Value
Parameter group: ExtensionParameters Arguments
--no-wait

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

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

Protected settings (may contain secrets). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: ExtensionParameters Arguments
--publisher

The name of the extension handler publisher.

Property Value
Parameter group: ExtensionParameters Arguments
--settings

Json formatted public settings for the extension. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: ExtensionParameters Arguments
--type

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

Property Value
Parameter group: ExtensionParameters Arguments
--type-handler-version

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

Property Value
Parameter group: ExtensionParameters 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.

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

Property Value
Default value: False

az stack-hci extension delete

Delete particular arc extension of HCI Cluster.

az stack-hci extension delete [--arc-setting-name]
                              [--cluster-name]
                              [--extension-name --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

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

--arc-setting-name

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

Property Value
Parameter group: Resource Id Arguments
--cluster-name

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--extension-name --name -n

The name of the machine extension.

Property Value
Parameter group: Resource Id 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
--no-wait

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

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

Property Value
Parameter group: Resource Id 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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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

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

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

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

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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.

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

Property Value
Default value: False

az stack-hci extension show

Get particular arc extension of HCI cluster.

az stack-hci extension show [--arc-setting-name]
                            [--cluster-name]
                            [--extension-name --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

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

--arc-setting-name

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

Property Value
Parameter group: Resource Id Arguments
--cluster-name

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--extension-name --name -n

The name of the machine extension.

Property Value
Parameter group: Resource Id 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
--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
--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

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 --name]
                            [--ids]
                            [--interval]
                            [--resource-group]
                            [--subscription]
                            [--timeout]
                            [--updated]

Optional Parameters

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

--arc-setting-name

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

Property Value
Parameter group: Resource Id Arguments
--cluster-name

The name of the cluster.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--extension-name --name -n

The name of the machine extension.

Property Value
Parameter group: Resource Id 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
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--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
--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
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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