Share via

az offazure hyperv host

  • Experimental

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

Commands

Name Description Type Status
az offazure hyperv host list

Get all hosts on the on-premise site.

 Extension Experimental
az offazure hyperv host show

Get the details of a Hyper-V host.

 Extension Experimental

az offazure hyperv host list

Experimental

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

Get all hosts on the on-premise site.

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

Examples

List hosts by site

az offazure hyperv host 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.

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 offazure hyperv host 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 host.

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

Examples

Get a host

az offazure hyperv host show --host-name MyHostName --resource-group                  MyResourceGroup --site-name MySiteName

Optional Parameters

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

--host-name --name -n

Name of the host.

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

Name of the Hyper-V Site.

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