az nginx deployment

Commands

Name	Description	Type	Status
az nginx deployment api-key	Managing Nginxaas deployment API Keys.	Extension	GA
az nginx deployment api-key create	Create an API Key for the Nginx deployment in order to access the dataplane API endpoint.	Extension	GA
az nginx deployment api-key delete	Delete API key for Nginx deployment.	Extension	GA
az nginx deployment api-key list	List all API Keys of the given Nginx deployment.	Extension	GA
az nginx deployment api-key show	Get the specified API Key of the given Nginx deployment.	Extension	GA
az nginx deployment api-key update	Update an API Key for the Nginx deployment in order to access the dataplane API endpoint.	Extension	GA
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 --deployment-name --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="standard_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="standard_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="standard_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=standard_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

Deployment with managed identity, storage account, and system assigned managed identity

az az anginx deployment create --deployment-name myDeployment --myResourceGroup azclitest-geo --location eastus --sku name=standard_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":"SystemAssigned"}' --logging storage-account='{"account-name":"myStorageAccount","container-name":"myContainer"}' --scaling-properties capacity=10

Required Parameters

Optional Parameters

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

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

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

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

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

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 nginx deployment show [--deployment-name --name]
                         [--ids]
                         [--resource-group]
                         [--subscription]

Examples

Deployment Get

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

Optional Parameters

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

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 nginx deployment update [--add]
                           [--auto-upgrade-profile]
                           [--deployment-name --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]
                           [--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

Optional Parameters

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

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

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