Share via

az offazure hyperv site

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

Commands

Name Description Type Status
az offazure hyperv site create

Create a Hyper-V site.

 Extension Experimental
az offazure hyperv site delete

Delete a Hyper-V site.

 Extension Experimental
az offazure hyperv site show

Get the details of a site.

 Extension Experimental

az offazure hyperv site create

Experimental

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

Create a Hyper-V site.

az offazure hyperv site create --name
                               --resource-group
                               [--agent]
                               [--appliance-name]
                               [--identity]
                               [--location]
                               [--solution-id]
                               [--tags]

Examples

Create a Hyper-V site

az offazure hyperv site create --resource-group MyResourceGroup --site-name MySiteName                  --location centralus

Required Parameters

--name --site-name -n

Name of the Hyper-V Site.

--resource-group -g

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

Optional Parameters

--agent

On-premises agent details.

Usage: --agent key-vault-uri=XX key-vault-id=XX

key-vault-uri: Key vault URI. key-vault-id: Key vault ARM Id.

--appliance-name

Name of the appliance.

--identity

Service principal identity details used by agent for communication to the service.

Usage: --identity tenant-id=XX application-id=XX object-id=XX audience=XX aad-authority=XX raw-cert-data=XX

tenant-id: Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. application-id: Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. object-id: Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. audience: Intended audience for the service principal. aad-authority: AAD Authority URL which was used to request the token for the service principal. raw-cert-data: Raw certificate data for building certificate expiry flows.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--solution-id

ARM ID of migration hub solution for SDS.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

Experimental

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

Delete a Hyper-V site.

az offazure hyperv site delete [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--yes]

Examples

Delete a Hyper-V site.

az offazure hyperv site delete --resource-group MyResourceGroup --site-name MySiteName

Optional Parameters

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

--name --site-name -n

Name of the Hyper-V Site.

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

Experimental

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

Get the details of a site.

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

Examples

Get a Hyper-V site

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

Optional Parameters

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

--name --site-name -n

Name of the Hyper-V Site.

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