Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,68 @@ F5 NGINXaaS for Azure (NGINXaaS) configurations can be managed using the Azure C

To create a new NGINX configuration, use the `az nginx deployment configuration create` command:

```shell
az nginx deployment configuration create --configuration-name
--deployment-name
--resource-group
[--files]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--package]
[--protected-files]
[--root-file]
```
There are two supported ways to upload your configuration:

1. **Plain file upload** — Upload one or more configuration files directly using the `--files` parameter.
2. **Tarball upload** — Package your configuration files into a `.tar.gz` archive and upload it using the `--package` parameter.

Both methods are valid and can be used depending on how your configuration is structured.

```shell
az nginx deployment configuration create --configuration-name
--deployment-name
--resource-group
[--files]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--package]
[--protected-files]
[--root-file]
```

### Validate your configuration

You can use the `analyze` command to validate your configuration before submitting it to the deployment:

<div data-testid="validation_tabs">
{{<tabs name="validate_configuration_examples" >}}

{{%tab name="Validate plain files"%}}

If you are uploading individual configuration files, you can pass them as base64-encoded content through the `--files` parameter:

```shell
az nginx deployment configuration analyze --deployment-name $DEPLOYMENT_NAME \
--resource-group $RESOURCE_GROUP --root-file /etc/nginx/nginx.conf \
--name default --files "$FILES_CONTENT"
````
```

### Examples
{{%/tab%}}

{{%tab name="Validate a tarball package"%}}

If you are using a `.tar.gz` archive, encode it and pass it through the `--package` parameter instead:

```shell
TAR_DATA=$(base64 -i nginx.tar.gz)
az nginx deployment configuration analyze --deployment-name myDeployment \
--resource-group myResourceGroup --root-file nginx.conf \
--name default --package data="$TAR_DATA"
```

{{%/tab%}}
{{< /tabs >}}
</div>

### Upload a configuration


<div data-testid="examples_tabs">
{{<tabs name="upload_configuration_examples" >}}

{{%tab name="Upload plain files"%}}

The following examples show how to upload plain configuration files directly to your deployment.

- Create a single file configuration:

Expand Down Expand Up @@ -90,6 +129,12 @@ az nginx deployment configuration analyze --deployment-name $DEPLOYMENT_NAME \
'virtual-path':'/etc/nginx/conf.d/proxy.conf'}]"
```

{{%/tab%}}

{{%tab name="Upload a tarball package"%}}

You can bundle your configuration files into a `.tar.gz` archive and upload it as a single package.

- Upload package with config files:

```shell
Expand Down Expand Up @@ -172,6 +217,10 @@ az nginx deployment configuration analyze --deployment-name $DEPLOYMENT_NAME \
'virtual-path':'/etc/nginx/conf.d/proxyprot.conf'}]"
```

{{%/tab%}}
{{< /tabs >}}
</div>

See the [Azure CLI Configuration Create Documentation](https://learn.microsoft.com/en-us/cli/azure/nginx/deployment/configuration?view=azure-cli-latest#az-nginx-deployment-configuration-create) for more details on the available parameters.


Expand Down