Del via


az network virtual-appliance

Manage Azure Network Virtual Appliance.

Commands

Name Description Type Status
az network virtual-appliance connection

Manage Azure Network Virtual Appliance Connection.

Core GA
az network virtual-appliance connection list

Lists connections under the NVA.

Core GA
az network virtual-appliance connection show

Get the details of specified NVA connection.

Core GA
az network virtual-appliance connection update

Update existing connection to Network Virtual Appliance.

Core GA
az network virtual-appliance connection wait

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

Core GA
az network virtual-appliance create

Create an Azure network virtual appliance.

Core GA
az network virtual-appliance delete

Delete an Azure network virtual appliance.

Core GA
az network virtual-appliance get-boot-diagnostic-log

Retrieve the boot diagnostic logs for a VM instance belonging to the specified Network Virtual Appliance.

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

Manage Azure Network Virtual Appliance Inbound Security Rules.

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

Create the specified Network Virtual Appliance Inbound Security Rules.

Core GA
az network virtual-appliance inbound-security-rule show

Get the available specified Network Virtual Appliance Inbound Security Rules Collection.

Core GA
az network virtual-appliance list

List all Azure network virtual appliance.

Core GA
az network virtual-appliance reimage

Reimages one VM belonging to the specified Network Virtual Appliance.

Core GA
az network virtual-appliance restart

Restarts one or more VMs belonging to the specified Network Virtual Appliance.

Core GA
az network virtual-appliance show

Show the detail of an Azure network virtual appliance.

Core GA
az network virtual-appliance site

Manage Azure Network Virtual Appliance Site.

Core GA
az network virtual-appliance site create

Create an Azure network virtual appliance site.

Core GA
az network virtual-appliance site delete

Delete an Azure network virtual appliance site.

Core GA
az network virtual-appliance site list

List all Azure network virtual appliance site.

Core GA
az network virtual-appliance site show

Show the detail of an Azure network virtual appliance site.

Core GA
az network virtual-appliance site update

Update an Azure network virtual appliance site.

Core GA
az network virtual-appliance site wait

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

Core GA
az network virtual-appliance sku

Manage Azure Network Virtual Appliance Sku.

Core GA
az network virtual-appliance sku list

List all Azure network virtual appliance sku.

Core GA
az network virtual-appliance sku show

Show the detail of an Azure network virtual appliance sku.

Core GA
az network virtual-appliance update

Update an Azure network virtual appliance.

Core GA
az network virtual-appliance wait

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

Core GA

az network virtual-appliance create

Create an Azure network virtual appliance.

az network virtual-appliance create --name
                                    --resource-group
                                    [--additional-nics]
                                    [--asn]
                                    [--boot-blobs --boot-strap-config-blobs]
                                    [--cloud-blobs --cloud-init-config-blobs]
                                    [--cloud-init-config --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

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

--additional-nics

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

Property Value
Parameter group: Properties Arguments
--asn

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--cloud-init-config --init-config

CloudInitConfiguration scripts that will be run during cloud initialization.

Property Value
Parameter group: Properties Arguments
--delegation

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

Property Value
Parameter group: Properties Arguments
--identity

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

Property Value
Parameter group: Parameters 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.

Property Value
Parameter group: Properties Arguments
--location -l

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

Property Value
Parameter group: Parameters Arguments
--network-profile

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

Property Value
Parameter group: Properties Arguments
--no-wait

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

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

Virtual Appliance Scale Unit.

Property Value
Parameter group: Sku Arguments
--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.

Property Value
Parameter group: Parameters Arguments
--vendor

Virtual Appliance Vendor.

Property Value
Parameter group: Sku Arguments
--version -v

Virtual Appliance Version.

Property Value
Parameter group: Sku Arguments
--vhub

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

Property Value
Parameter group: VirtualHub Arguments
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 network virtual-appliance delete

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

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

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

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of Network Virtual Appliance.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network virtual-appliance get-boot-diagnostic-log

Retrieve the boot diagnostic logs for a VM instance belonging to the specified Network Virtual Appliance.

az network virtual-appliance get-boot-diagnostic-log [--console-screenshot-storage-sas-url --css-sas-url]
                                                     [--ids]
                                                     [--instance-id]
                                                     [--name --network-virtual-appliance-name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--resource-group]
                                                     [--scs-sas-url --serial-console-storage-sas-url]
                                                     [--subscription]

Examples

Get boot diagnostic logs

az network virtual-appliance get-boot-diagnostic-log --resource-group rg --network-virtual-appliance-name name --scs-sas-url serialconsole-sas-url --css-sas-url consoleScreenshot-sas-url

Optional Parameters

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

--console-screenshot-storage-sas-url --css-sas-url

Specify the sas-url to the storage blob into which console screen shot for the requested instance will be written.

Property Value
Parameter group: Request Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--instance-id

The network virtual appliance instance id for which boot diagnostic logs is being requested.

Property Value
Parameter group: Request Arguments
--name --network-virtual-appliance-name -n

The name of Network Virtual Appliance.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Resource Id Arguments
--scs-sas-url --serial-console-storage-sas-url

Specify the sas-url to the storage blob into which serial console logs for the requested instance will be written.

Property Value
Parameter group: Request Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network virtual-appliance list

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

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

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
--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 network virtual-appliance reimage

Reimages one VM belonging to the specified Network Virtual Appliance.

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

Examples

Reimages Specific NetworkVirtualAppliance VMs in VM Scale Set

az network virtual-appliance reimage--resource-group rg1 --network-virtual-appliance-name nvaName --subscription subscriptionId --instance-ids 0

Optional Parameters

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

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

Property Value
Parameter group: Resource Id Arguments
--instance-ids

The network virtual appliance instance ids. Omitting the network virtual appliance instance ids will result in the operation being performed on all virtual machines belonging to the network virtual appliance. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: NetworkVirtualApplianceInstanceIds Arguments
--name --network-virtual-appliance-name -n

The name of Network Virtual Appliance.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network virtual-appliance restart

Restarts one or more VMs belonging to the specified Network Virtual Appliance.

Restarting all or multiple VM instances will restart the VMs in parallel.

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

Examples

Restart one network virtual appliance VM

az network virtual-appliance restart --resource-group rg1 --network-virtual-appliance-name nvaName --subscription subscriptionId --instance-ids 0

Restart multiple network virtual appliance VMs in parallel

az network virtual-appliance restart --resource-group rg1 --network-virtual-appliance-name nva --subscription subscriptionId --instance-ids 0 2

Optional Parameters

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

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

Property Value
Parameter group: Resource Id Arguments
--instance-ids

Space-separated list of IDs (ex: 1 2 3 ...). Specifying more than one NVA instance id will result in the operation being performed on the corresponding virtual machines parallelly. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: NetworkVirtualApplianceInstanceIds Arguments
--name --network-virtual-appliance-name -n

The name of the network virtual appliance.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of the resource group.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network virtual-appliance show

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

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

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

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of Network Virtual Appliance.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network virtual-appliance update

Update an Azure network virtual appliance.

az network virtual-appliance update [--add]
                                    [--additional-nics]
                                    [--asn]
                                    [--boot-blobs --boot-strap-config-blobs]
                                    [--cloud-blobs --cloud-init-config-blobs]
                                    [--cloud-init-config --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

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

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

Property Value
Parameter group: Generic Update Arguments
--additional-nics

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

Property Value
Parameter group: Properties Arguments
--asn

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--cloud-init-config --init-config

CloudInitConfiguration scripts that will be run during cloud initialization.

Property Value
Parameter group: Properties Arguments
--delegation

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

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: 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.

Property Value
Parameter group: Properties Arguments
--location -l

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

Property Value
Parameter group: Parameters Arguments
--name -n

The name of Network Virtual Appliance.

Property Value
Parameter group: Resource Id Arguments
--network-profile

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

Property Value
Parameter group: Properties Arguments
--no-wait

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

Property Value
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 <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--scale-unit

Virtual Appliance Scale Unit.

Property Value
Parameter group: Sku Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Parameters Arguments
--vendor

Virtual Appliance Vendor.

Property Value
Parameter group: Sku Arguments
--version -v

Virtual Appliance Version.

Property Value
Parameter group: Sku Arguments
--vhub

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

Property Value
Parameter group: VirtualHub Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network virtual-appliance wait

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

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

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

The name of Network Virtual Appliance.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False