Share via

az nginx deployment

  • Reference

Note

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

Manage NGINX deployment resources.

Commands

Name Description Type Status
az nginx deployment certificate

Manage NGINX certificate resources.

 Extension GA
az nginx deployment certificate create

Create a certificate for an NGINX deployment.

 Extension GA
az nginx deployment certificate delete

Delete an NGINX deployment certificate.

 Extension GA
az nginx deployment certificate list

List all certificates under the specified deployment and resource group.

 Extension GA
az nginx deployment certificate show

Get the properties of a specific NGINX certificate.

 Extension GA
az nginx deployment certificate update

Update an NGINX deployment certificate.

 Extension GA
az nginx deployment certificate wait

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

 Extension GA
az nginx deployment configuration

Manage NGINX configuration resources.

 Extension GA
az nginx deployment configuration analyze

Analyze an NGINX configuration without applying it to the NGINXaaS deployment.

 Extension GA
az nginx deployment configuration create

Create a configuration for an NGINX deployment.

 Extension GA
az nginx deployment configuration delete

Delete an Nginx configuration.

 Extension GA
az nginx deployment configuration list

List all configurations under the specified deployment and resource group.

 Extension GA
az nginx deployment configuration show

Get the properties of a specific NGINX configuration.

 Extension GA
az nginx deployment configuration update

Update an NGINX configuration.

 Extension GA
az nginx deployment configuration wait

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

 Extension GA
az nginx deployment create

Create an NGINX for Azure resource.

 Extension GA
az nginx deployment delete

Delete an NGINX deployment.

 Extension GA
az nginx deployment list

List of NGINX deployments.

 Extension GA
az nginx deployment show

Get the properties of a specific NGINX Deployment.

 Extension GA
az nginx deployment update

Update an NGINX deployment.

 Extension GA
az nginx deployment wait

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

 Extension GA

az nginx deployment create

Create an NGINX for Azure resource.

az nginx deployment create --deployment-name
                           --resource-group
                           [--auto-upgrade-profile]
                           [--enable-diagnostics {0, 1, f, false, n, no, t, true, y, yes}]
                           [--identity]
                           [--location]
                           [--logging]
                           [--network-profile]
                           [--nginx-app-protect]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--scaling-properties]
                           [--sku]
                           [--tags]
                           [--user-profile]

Examples

Deployment Create with PublicIP

az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standardv2_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{public-ip-addresses:[{id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIP}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}"

Deployment Create with PrivateIP

az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standardv2_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{private-ip-addresses:[{private-ip-allocation-method:Static,subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet,private-ip-address:10.0.0.2}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}"
az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standardv2_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{private-ip-addresses:[{private-ip-allocation-method:Dynamic,subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet,private-ip-address:10.0.0.2}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}"

Deployment with managed identity, storage account and scaling

az anginx deployment  create --deployment-name myDeployment --myResourceGroup azclitest-geo --location eastus --sku name=standardv2_Monthly_gmz7xq9ge3py --network-profile network-interface-configuration='{subnet-id:/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet-azclitest/subnets/mySubnet}' front-end-ip-configuration='{public-ip-addresses:[{id:/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIP}]}' --identity '{"type":"UserAssigned","userAssignedIdentities":{"/subscriptions/subscriptionId/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myManagedIdentity":{}}}' --logging storage-account='{"account-name":"myStorageAccount","container-name":"myContainer"}' --scaling-properties capacity=10

Required Parameters

--deployment-name --name -n

The name of the targeted NGINX deployment.

--resource-group -g

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

Optional Parameters

--auto-upgrade-profile

Autoupgrade settings of a deployment. can be stable or preview Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--enable-diagnostics

Boolean to enable/disable diagnostics support.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity

Managed identity to perform operations on Azure key vault or storage account 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>.

--logging

To have logs sent to your storage account. Must specify managed identity with blob contributor role on Azure storage account Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--network-profile

IP address and VNet + subnet information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--nginx-app-protect

Settings for NGINX App Protect (NAP) 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
--scaling-properties

Scaling for NGINX capacity units (NCUs) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--sku

The billing information for the resource Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--tags

Tags for deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-profile

Optional: Preferred communication email Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 nginx deployment delete

Delete an NGINX deployment.

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

Examples

Deployment Delete

az nginx deployment delete --name myDeployment --resource-group myResourceGroup

Optional Parameters

--deployment-name --name -n

The name of targeted NGINX deployment.

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

--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 nginx deployment list

List of NGINX deployments.

List all deployments under the specified subscription. List all Nginx Deployments under the specified resource group.

az nginx deployment list [--max-items]
                         [--next-token]
                         [--resource-group]

Examples

Deployment List

az nginx deployment list
az nginx deployment list --resource-group myResourceGroup

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 nginx deployment show

Get the properties of a specific NGINX Deployment.

az nginx deployment show [--deployment-name]
                         [--ids]
                         [--resource-group]
                         [--subscription]

Examples

Deployment Get

az nginx deployment show --name myDeployment --resource-group myResourceGroup

Optional Parameters

--deployment-name --name -n

The name of targeted Nginx deployment.

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

--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 nginx deployment update

Update an NGINX deployment.

az nginx deployment update [--add]
                           [--auto-upgrade-profile]
                           [--deployment-name]
                           [--enable-diagnostics {0, 1, f, false, n, no, t, true, y, yes}]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--identity]
                           [--ids]
                           [--location]
                           [--logging]
                           [--network-profile]
                           [--nginx-app-protect]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--remove]
                           [--resource-group]
                           [--scaling-properties]
                           [--set]
                           [--sku]
                           [--subscription]
                           [--tags]
                           [--user-profile]

Examples

Update tags and enable diagnostics support for a deployment

az nginx deployment update --name myDeployment --resource-group myResourceGroup --location eastus2 --tags tag1="value1" tag2="value2" --enable-diagnostics --nginx-app-protect web-application-firewall-settings="{"activation-state":"Enabled"}"

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

--auto-upgrade-profile

Autoupgrade settings of a deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--deployment-name --name -n

The name of targeted Nginx deployment.

--enable-diagnostics

Boolean to enable/disable diagnostics support.

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.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--identity

Managed identity to perform operations on Azure key vault or storage account 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.

--location -l

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

--logging

To have logs sent to your storage account. Must specify managed identity with blob contributor role on Azure storage account Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--network-profile

IP address and VNet + subnet information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--nginx-app-protect

Settings for NGINX App Protect (NAP) 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 <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--scaling-properties

Scaling for NGINX capacity units (NCUs) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--set

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

--sku

The billing information for the resource Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--subscription

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

--tags

Tags for deployment. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-profile

Optional: Preferred communication email Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 nginx deployment wait

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

az nginx deployment wait [--created]
                         [--custom]
                         [--deleted]
                         [--deployment-name]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--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
--deployment-name --name -n

The name of targeted Nginx deployment.

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