az network virtual-appliance connection

  • Preview
  • Reference

Command group 'az network virtual-appliance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Network Virtual Appliance Connection.

Commands

Name Description Type Status
az network virtual-appliance connection list

Lists connections under the NVA.

 Core Preview
az network virtual-appliance connection show

Get the details of specified NVA connection.

 Core Preview
az network virtual-appliance connection update

Update existing connection to Network Virtual Appliance.

 Core Preview
az network virtual-appliance connection wait

Place the CLI in a waiting state until a condition is met.

 Core Preview

az network virtual-appliance connection list

Edit
Preview

Command group 'az network virtual-appliance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists connections under the NVA.

az network virtual-appliance connection list --nva
                                             --resource-group
                                             [--max-items]
                                             [--next-token]

Examples

List Network Virtual Appliance Connections under the NVA

az network virtual-appliance connection list --nva  MyNVA -g MyRG

Required Parameters

--nva --virtual-appliance-name

The name of the Network Virtual Appliance.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 network virtual-appliance connection show

Edit
Preview

Command group 'az network virtual-appliance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of specified NVA connection.

az network virtual-appliance connection show [--ids]
                                             [--name]
                                             [--nva]
                                             [--resource-group]
                                             [--subscription]

Examples

Show Network Virtual Appliance Connection

az network virtual-appliance connection show -n defaultConnection --nva  MyNVA -g MyRG

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

The name of the NVA connection.

default value: defaultConnection
--nva --virtual-appliance-name

The name of the Network Virtual Appliance.

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

az network virtual-appliance connection update

Edit
Preview

Command group 'az network virtual-appliance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update existing connection to Network Virtual Appliance.

az network virtual-appliance connection update [--add]
                                               [--associated-route-table]
                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--ids]
                                               [--inbound-route-map]
                                               [--labels]
                                               [--name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--nva]
                                               [--outbound-route-map]
                                               [--propagated]
                                               [--remove]
                                               [--resource-group]
                                               [--set]
                                               [--subscription]

Examples

Update NVA connection routing configuration - change associated route table

az network virtual-appliance connection update --name defaultConnection  --nva MyNva -g MyRG --subscription <subId> --associated-route-table "{'id': '/subscriptions/<subId>/resourceGroups/<MyRG>/providers/Microsoft.Network/virtualHubs/<vhubName>/hubRouteTables/<customRouteTable>'}"

Update NVA connection routing configuration - add Propagated route table Labels

az network virtual-appliance connection update --name defaultConnection  --nva MyNva -g MyRG --subscription <subId>  --labels [label1,label2]

Update NVA connection routing configuration - add propagated route table id

az network virtual-appliance connection update --name defaultConnection  --nva MyNva -g MyRG --subscription <subId>   --propagated "[{'id':'<routeTable1id>'},{'id':'<routeTable2id>'}]"

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--associated-route-table

The resource id RouteTable associated with this RoutingConfiguration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--inbound-route-map

The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--labels --propagated-route-table-labels

The list of labels. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name -n

The name of the NVA connection.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--nva --virtual-appliance-name

The name of the Network Virtual Appliance.

--outbound-route-map

The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--propagated --propagated-route-table-ids

List of resource id of propagated route tables. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

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

az network virtual-appliance connection wait

Edit
Preview

Command group 'az network virtual-appliance' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az network virtual-appliance connection wait [--created]
                                             [--custom]
                                             [--deleted]
                                             [--exists]
                                             [--ids]
                                             [--interval]
                                             [--name]
                                             [--nva]
                                             [--resource-group]
                                             [--subscription]
                                             [--timeout]
                                             [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--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.

--interval

Polling interval in seconds.

default value: 30
--name -n

The name of the NVA connection.

default value: defaultConnection
--nva --virtual-appliance-name

The name of the Network Virtual Appliance.

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.