Share via

az offazure hyperv cluster

  • Experimental
  • Reference

Note

This reference is part of the offazure extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az offazure hyperv cluster command. Learn more about extensions.

Command group 'offazure' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Hyper-V cluster.

Commands

Name Description Type Status
az offazure hyperv cluster list

Get all clusters on the on-premise site.

 Extension Experimental
az offazure hyperv cluster show

Get the details of a Hyper-V cluster.

 Extension Experimental

az offazure hyperv cluster list

Experimental

Command group 'offazure' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get all clusters on the on-premise site.

az offazure hyperv cluster list --resource-group
                                --site-name

Examples

List clusters by site

az offazure hyperv cluster list --resource-group MyResourceGroup --site-name MySiteName

Required Parameters

--resource-group -g

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

--site-name

Name of the Hyper-V Site.

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 offazure hyperv cluster show

Experimental

Command group 'offazure' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of a Hyper-V cluster.

az offazure hyperv cluster show [--cluster-name]
                                [--ids]
                                [--resource-group]
                                [--site-name]
                                [--subscription]

Examples

Get a cluster

az offazure hyperv cluster show --cluster-name MyClusterName --resource-group                  MyResourceGroup --site-name MySiteName

Optional Parameters

--cluster-name --name -n

Name of the cluster.

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

--site-name

Name of the Hyper-V Site.

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