az aksarc vnet

Note

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

Manage virtual networks for provisioned clusters.

Commands

Name	Description	Type	Status
az aksarc vnet create	Creates the virtual network.	Extension	GA
az aksarc vnet delete	Deletes the virtual network.	Extension	GA
az aksarc vnet list	Lists the virtual networks by resource group or subscription.	Extension	GA
az aksarc vnet show	Gets the virtual network.	Extension	GA

az aksarc vnet create

Creates the virtual network.

az aksarc vnet create --custom-location
                      --name
                      --resource-group
                      [--location]
                      [--moc-group]
                      [--moc-location]
                      [--moc-vnet-name]
                      [--no-wait]
                      [--tags]

Examples

PutVirtualNetwork

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

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

--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 Azure Local Infrastructure.

Property	Value
Default value:	target-group

--moc-location

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

Property	Value
Default value:	MocLocation

--moc-vnet-name

Name of the MOC network for Azure Local Infrastructure.

--no-wait

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

Property	Value
Default value:	False

--tags

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

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

Deletes the virtual network.

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

Examples

DeleteVirtualNetwork

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

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

--no-wait

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

Property	Value
Default value:	False

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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 aksarc vnet list

Lists the virtual networks by resource group or subscription.

az aksarc vnet list [--resource-group]

Examples

ListVirtualNetworkByResourceGroup

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

ListVirtualNetworkBySubscription

az aksarc vnet list

Optional Parameters

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

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

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

Gets the virtual network.

az aksarc vnet show --name
                    --resource-group

Examples

GetVirtualNetwork

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

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