az network virtual-appliance

  • Preview
  • Reference

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Network Virtual Appliance.

Commands

Name Description Type Status
az network virtual-appliance connection

Manage Azure Network Virtual Appliance Connection.

 Core Preview
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 create

Create an Azure network virtual appliance.

 Core Preview
az network virtual-appliance delete

Delete an Azure network virtual appliance.

 Core Preview
az network virtual-appliance inbound-security-rule

Manage Azure Network Virtual Appliance Inbound Security Rules.

 Core Preview
az network virtual-appliance inbound-security-rule create

Create the specified Network Virtual Appliance Inbound Security Rules.

 Core Preview
az network virtual-appliance list

List all Azure network virtual appliance.

 Core Preview
az network virtual-appliance show

Show the detail of an Azure network virtual appliance.

 Core Preview
az network virtual-appliance site

Manage Azure Network Virtual Appliance Site.

 Core Preview
az network virtual-appliance site create

Create an Azure network virtual appliance site.

 Core Preview
az network virtual-appliance site delete

Delete an Azure network virtual appliance site.

 Core Preview
az network virtual-appliance site list

List all Azure network virtual appliance site.

 Core Preview
az network virtual-appliance site show

Show the detail of an Azure network virtual appliance site.

 Core Preview
az network virtual-appliance site update

Update an Azure network virtual appliance site.

 Core Preview
az network virtual-appliance site wait

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

 Core Preview
az network virtual-appliance sku

Manage Azure Network Virtual Appliance Sku.

 Core Preview
az network virtual-appliance sku list

List all Azure network virtual appliance sku.

 Core Preview
az network virtual-appliance sku show

Show the detail of an Azure network virtual appliance sku.

 Core Preview
az network virtual-appliance update

Update an Azure network virtual appliance.

 Core Preview
az network virtual-appliance wait

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

 Core Preview

az network virtual-appliance create

Edit
Preview

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

Create an Azure network virtual appliance.

az network virtual-appliance create --name
                                    --resource-group
                                    [--additional-nics]
                                    [--asn]
                                    [--boot-blobs]
                                    [--cloud-blobs]
                                    [--cloud-init-config]
                                    [--delegation]
                                    [--identity]
                                    [--internet-ingress-ips]
                                    [--location]
                                    [--network-profile]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--scale-unit]
                                    [--tags]
                                    [--vendor]
                                    [--version]
                                    [--vhub]

Examples

Create an Azure network virtual appliance.

az network virtual-appliance create -n MyName -g MyRG --vhub {vhubID} --vendor "barracudasdwanrelease" --scale-unit 2 -v latest --asn 10000 --init-config "echo $hello" --boot-blobs {blobUrl1} {blobUrl2} --cloud-blobs {blobUrl3} {blobUrl4}

Required Parameters

--name -n

The name of Network Virtual Appliance.

--resource-group -g

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

Optional Parameters

--additional-nics

Details required for Additional Network Interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--asn

VirtualAppliance ASN. The valid value ranges from 1 to 4294967295.

--boot-blobs --boot-strap-config-blobs

Space-separated list of BootStrapConfigurationBlobs storage URLs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cloud-blobs --cloud-init-config-blobs

Space-separated list of CloudInitConfigurationBlob storage URLs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cloud-init-config --init-config

CloudInitConfiguration scripts that will be run during cloud initialization.

--delegation

The delegation for the Virtual Appliance Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--identity

The identity of the Network Virtual Appliance, if configured. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--internet-ingress-ips

List of Resource Uri of Public IPs for Internet Ingress Scenario. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

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

--network-profile

Network Profile containing configurations for Public and Private NIC. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--scale-unit

Virtual Appliance Scale Unit.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vendor

Virtual Appliance Vendor.

--version -v

Virtual Appliance Version.

--vhub

Name or ID of the virtual hub to which the Security Partner Provider belongs.

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 delete

Edit
Preview

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

Delete an Azure network virtual appliance.

az network virtual-appliance delete [--ids]
                                    [--name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--yes]

Examples

Delete an Azure network virtual appliance.

az network virtual-appliance delete -n MyName -g MyRG -y

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 Network Virtual Appliance.

--no-wait

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

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

Edit
Preview

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

List all Azure network virtual appliance.

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

Examples

List all Azure network virtual appliances.

az network virtual-appliance list -g MyRG

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.

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

Edit
Preview

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

Show the detail of an Azure network virtual appliance.

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

Examples

Show the detail of an Azure network virtual appliance.

az network virtual-appliance show -n MyName -g MyRG

Optional Parameters

--expand

Expands referenced resources. Default value is None.

--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 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 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 an Azure network virtual appliance.

az network virtual-appliance update [--add]
                                    [--additional-nics]
                                    [--asn]
                                    [--boot-blobs]
                                    [--cloud-blobs]
                                    [--cloud-init-config]
                                    [--delegation]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--identity]
                                    [--ids]
                                    [--internet-ingress-ips]
                                    [--location]
                                    [--name]
                                    [--network-profile]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--remove]
                                    [--resource-group]
                                    [--scale-unit]
                                    [--set]
                                    [--subscription]
                                    [--tags]
                                    [--vendor]
                                    [--version]
                                    [--vhub]

Examples

Update an Azure network virtual appliance.

az network virtual-appliance update -n MyName -g MyRG --asn 20000 --init-config "echo $hello"

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

--additional-nics

Details required for Additional Network Interface. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--asn

VirtualAppliance ASN. The valid value ranges from 1 to 4294967295.

--boot-blobs --boot-strap-config-blobs

Space-separated list of BootStrapConfigurationBlobs storage URLs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cloud-blobs --cloud-init-config-blobs

Space-separated list of CloudInitConfigurationBlob storage URLs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cloud-init-config --init-config

CloudInitConfiguration scripts that will be run during cloud initialization.

--delegation

The delegation for the Virtual Appliance 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
--identity

The identity of the Network Virtual Appliance, if configured. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--internet-ingress-ips

List of Resource Uri of Public IPs for Internet Ingress Scenario. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location -l

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

--name -n

The name of Network Virtual Appliance.

--network-profile

Network Profile containing configurations for Public and Private NIC. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

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

--scale-unit

Virtual Appliance Scale Unit.

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vendor

Virtual Appliance Vendor.

--version -v

Virtual Appliance Version.

--vhub

Name or ID of the virtual hub to which the Security Partner Provider belongs.

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 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 wait [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--expand]
                                  [--ids]
                                  [--interval]
                                  [--name]
                                  [--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
--expand

Expands referenced resources. Default value is None.

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