Share via


az hybridaks vnet

Note

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

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

Manage virtual networks for hybridaks.

Commands

Name Description Type Status
az hybridaks vnet create

Creates the Hybrid AKS virtual network.

Extension Preview
az hybridaks vnet delete

Deletes the Hybrid AKS virtual network.

Extension Preview
az hybridaks vnet list

Lists the Hybrid AKS virtual networks by resource group or subscription.

Extension Preview
az hybridaks vnet show

Gets the Hybrid AKS virtual network.

Extension Preview

az hybridaks vnet create

Preview

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

Creates the Hybrid AKS virtual network.

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

Examples

PutVirtualNetwork

az hybridaks 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

--aods-vnet-id

ID of the network for AODS Infrastructure.

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

Preview

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

Deletes the Hybrid AKS virtual network.

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

Examples

DeleteVirtualNetwork

az hybridaks 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 hybridaks vnet list

Preview

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

Lists the Hybrid AKS virtual networks by resource group or subscription.

az hybridaks vnet list [--resource-group]

Examples

ListVirtualNetworkByResourceGroup

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

ListVirtualNetworkBySubscription

az hybridaks 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 hybridaks vnet show

Preview

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

Gets the Hybrid AKS virtual network.

az hybridaks vnet show --name
                       --resource-group

Examples

GetVirtualNetwork

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