az network virtual-appliance site

Manage Azure Network Virtual Appliance Site.

Commands

Name	Description	Type	Status
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 site create

Create an Azure network virtual appliance site.

az network virtual-appliance site create --appliance-name
                                         --name
                                         --resource-group
                                         [--address-prefix]
                                         [--allow {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--default {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--optimize {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create an Azure network virtual appliance site.

az network virtual-appliance site create -n MyName -g MyRG --appliance-name MyAppliance --address-prefix 10.0.0.0/24 --allow --default --optimize

Required Parameters

--appliance-name

The name of Network Virtual Appliance.

--name -n

The name of Network Virtual Appliance Site.

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

--address-prefix

Address Prefix of Network Virtual Appliance Site.

--allow

Flag to control breakout of o365 allow category. Allowed values: false, true.

Property	Value
Parameter group:	Breakout of O365 Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--default

Flag to control breakout of o365 default category. Allowed values: false, true.

Property	Value
Parameter group:	Breakout of O365 Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--optimize

Flag to control breakout of o365 optimize category. Allowed values: false, true.

Property	Value
Parameter group:	Breakout of O365 Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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 site delete

Delete an Azure network virtual appliance site.

az network virtual-appliance site delete [--appliance-name]
                                         [--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 site.

az network virtual-appliance site delete -n MySite -g MyRG --appliance-name MyName -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.

--appliance-name

The name of Network Virtual Appliance.

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

--name -n

The name of Network Virtual Appliance Site.

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 site list

List all Azure network virtual appliance site.

az network virtual-appliance site list --appliance-name
                                       --resource-group

Examples

List all Azure network virtual appliance site.

az network virtual-appliance site list -g MyRG --appliance-name MyName

Required Parameters

--appliance-name

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

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 site show

Show the detail of an Azure network virtual appliance site.

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

Examples

Show the detail of an Azure network virtual appliance site.

az network virtual-appliance site show -n MySite -g MyRG --appliance-name MyName

Optional Parameters

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

--appliance-name

The name of Network Virtual Appliance.

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

--name -n

The name of Network Virtual Appliance Site.

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 site update

Update an Azure network virtual appliance site.

az network virtual-appliance site update [--add]
                                         [--address-prefix]
                                         [--allow {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--appliance-name]
                                         [--default {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--optimize {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]

Examples

Update an Azure network virtual appliance site.

az network virtual-appliance site update -n MyName -g MyRG --appliance-name MyAppliance --address-prefix 10.0.0.0/24 --allow false --default false --optimize false

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

--address-prefix

Address Prefix of Network Virtual Appliance Site.

--allow

Flag to control breakout of o365 allow category. Allowed values: false, true.

Property	Value
Parameter group:	Breakout of O365 Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--appliance-name

The name of Network Virtual Appliance.

Property	Value
Parameter group:	Resource Id Arguments

--default

Flag to control breakout of o365 default category. Allowed values: false, true.

Property	Value
Parameter group:	Breakout of O365 Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

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

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

--optimize

Flag to control breakout of o365 optimize category. Allowed values: false, true.

Property	Value
Parameter group:	Breakout of O365 Arguments
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

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

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 site wait

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

az network virtual-appliance site wait [--appliance-name]
                                       [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--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.

--appliance-name

The name of Network Virtual Appliance.

Property	Value
Parameter group:	Resource Id Arguments

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

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

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