Share via

az akshybrid vnet

  • Preview
  • Reference

Note

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

Command group 'akshybrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage virtual networks for provisioned clusters.

Commands

Name Description Type Status
az akshybrid vnet create

Creates the virtual network.

 Extension Preview
az akshybrid vnet delete

Deletes the virtual network.

 Extension Preview
az akshybrid vnet list

Lists the virtual networks by resource group or subscription.

 Extension Preview
az akshybrid vnet show

Gets the virtual network.

 Extension Preview

az akshybrid vnet create

Preview

Command group 'akshybrid vnet' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Creates the virtual network.

az akshybrid vnet create --custom-location
                         --name
                         --resource-group
                         [--location]
                         [--moc-group]
                         [--moc-location]
                         [--moc-vnet-name]
                         [--no-wait]
                         [--tags]
                         [--vsphere-segment-name]

Examples

PutVirtualNetwork

az akshybrid vnet create --name "test-vnet-static" --resource-group "test-arcappliance-resgrp" --custom-location "testcustomlocation" --moc-vnet-name "test-vnet"

Required Parameters

--custom-location

Name or ID of the custom location to use for the virtual network.

--name -n

Name of the virtual network.

--resource-group -g

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

Optional Parameters

--location -l

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

--moc-group

Name of the MOC group containing the MOC network for HCI Infrastructure.

Default value: target-group
--moc-location

Name of the MOC location containing the MOC group with the network for HCI Infrastructure.

Default value: MocLocation
--moc-vnet-name

Name of the MOC network for HCI Infrastructure.

--no-wait

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

Default value: False
--tags

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

--vsphere-segment-name

Name of the VSphere segment for VMware Infrastructure.

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 akshybrid vnet delete

Preview

Command group 'akshybrid vnet' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes the virtual network.

az akshybrid vnet delete --name
                         --resource-group
                         [--no-wait]
                         [--yes]

Examples

DeleteVirtualNetwork

az akshybrid vnet delete --resource-group "test-arcappliance-resgrp" --name "test-vnet-static"

Required Parameters

--name -n

Name of the virtual network.

--resource-group -g

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

Optional Parameters

--no-wait

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

Default value: False
--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 akshybrid vnet list

Preview

Command group 'akshybrid vnet' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists the virtual networks by resource group or subscription.

az akshybrid vnet list [--resource-group]

Examples

ListVirtualNetworkByResourceGroup

az akshybrid vnet list --resource-group "test-arcappliance-resgrp"

ListVirtualNetworkBySubscription

az akshybrid vnet list

Optional Parameters

--resource-group -g

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

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 akshybrid vnet show

Preview

Command group 'akshybrid vnet' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets the virtual network.

az akshybrid vnet show --name
                       --resource-group

Examples

GetVirtualNetwork

az akshybrid vnet show --resource-group "test-arcappliance-resgrp" --name "test-vnet-static"

Required Parameters

--name -n

Name of the virtual network.

--resource-group -g

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

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.