CLI

Learn how to use the Azure CLI extension to manage NGINXaaS for Azure.

The Azure CLI has an extension to be used for management of NGINXaaS for Azure deployments whether that be locally or in continuous integration pipelines. This document links you to information around basic NGINXaaS extension usage.

Prerequisites

• NGINXaaS Prerequisites
• Azure CLI version 2.40.0 or greater
  • Azure CLI Installation
• You need to be logged in to your Azure account through the CLI
  • Azure CLI Authentication

Install the NGINXaaS for Azure extension

Note:
The extension will automatically install the first time you run an az nginx command.

az extension add --name nginx

Workflows

See Azure NGINXaaS for Azure CLI Doc for a complete list of NGINXaaS CLI commands.

Create a deployment

See Azure CLI Deployment Create Documentation for example commands to create deployment resources.

• NGINXaaS Managed Identity Documentation
• NGINXaaS for Azure Azure Monitor Documentation
• Azure CLI Public IP Documentation
• Azure CLI Storage Container Documentation

Update a deployment

See Azure CLI Deployment Update Documentation for an example command to update deployment resources.

• NGINXaaS Managed Identity Documentation
• NGINXaaS for Azure Azure Monitor Documentation

Delete a deployment

See Azure CLI Deployment Delete Documentation for an example command to delete deployment resources.

Create a certificate

Create a certificate under a deployment. This references an existing certificate in an Azure Key Vault and makes it available to NGINX configuration. See Azure CLI Certificate Create Documentation for an example command to create certificate resources.

• NGINXaaS Certificates Documentation
• Azure CLI Key Vault Documentation

Update a certificate

Update a certificate under a deployment. This references an existing certificate in an Azure Key Vault and makes it available to NGINX configuration. See Azure CLI Certificate Create Documentation for an example command to update certificate resources.

• NGINXaaS Certificates Documentation
• Azure CLI Key Vault Documentation

Delete a certificate

See Azure CLI Certificate Delete Documentation for an example command to delete certificate resources.

• NGINXaaS Certificates Documentation
• Azure CLI Key Vault Documentation

Create a configuration

Create a configuration for a deployment using a gzipped archive based on the NGINXaaS documentation below. See Azure CLI Configuration Create Documentation for example commands to create configuration resources.

• NGINXaaS GZIP Configuration Documentation

Update a configuration

Update a configuration for a deployment using a gzipped archive based on the NGINXaaS documentation below. See Azure CLI Configuration Update Documentation for an example command to update configuration resources.

• NGINXaaS GZIP Configuration Documentation

Additional Docs

If you are new to the Azure CLI, see:

• Azure CLI Overview