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.
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 |
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]
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"
The name of the proxy resource holding details of HCI ArcSetting information.
The name of the cluster.
The name of the machine extension.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
How the extension handler should be forced to update even if the extension configuration has not changed.
Do not wait for the long-running operation to finish.
Protected settings (may contain secrets). Support json-file and yaml-file.
The name of the extension handler publisher.
Json formatted public settings for the extension. Support json-file and yaml-file.
Specifies the type of the extension; an example is "CustomScriptExtension".
Specifies the version of the script handler. Latest version would be used if not specified.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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]
Delete arc extension
az stack-hci extension delete --arc-setting-name "default" --cluster-name "myCluster" --name "MicrosoftMonitoringAgent" --resource-group "test-rg"
The name of the proxy resource holding details of HCI ArcSetting information.
The name of the cluster.
The name of the machine extension.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List all extensions under arc setting resource.
az stack-hci extension list --arc-setting-name
--cluster-name
--resource-group
[--max-items]
[--next-token]
List extensions under arc setting resource
az stack-hci extension list --arc-setting-name "default" --cluster-name "myCluster" --resource-group "test-rg"
The name of the proxy resource holding details of HCI ArcSetting information.
The name of the cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Get particular arc extension of HCI cluster.
az stack-hci extension show [--arc-setting-name]
[--cluster-name]
[--extension-name]
[--ids]
[--resource-group]
[--subscription]
Get arc settings extension
az stack-hci extension show --arc-setting-name "default" --cluster-name "myCluster" --name "MicrosoftMonitoringAgent" --resource-group "test-rg"
The name of the proxy resource holding details of HCI ArcSetting information.
The name of the cluster.
The name of the machine extension.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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]
The name of the proxy resource holding details of HCI ArcSetting information.
The name of the cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
The name of the machine extension.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: