azure-mgmt-nginx 3.1.0b2
Microsoft Azure Nginx Management Client Library for Python
License: MIT License
Requires Python: >=3.8
Keywords: azure, azure sdk

# Microsoft Azure SDK for Python

This is the Microsoft Azure Nginx Management Client Library.
This package has been tested with Python 3.8+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

## Getting started

### Prerequisites

- Python 3.8+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-nginx
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.nginx import NginxManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = NginxManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search Nginx Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
- [Other Nginx Management doc](https://github.com/nginxinc/nginxaas-for-azure-snippets/tree/main/sdk/python)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project. 


# Release History

## 3.1.0b2 (2025-02-23)

### Features Added

  - Client `NginxManagementClient` added operation group `api_keys`
  - Model `AnalysisResultData` added property `diagnostics`
  - Model `NginxDeploymentProperties` added property `nginx_app_protect`
  - Model `NginxDeploymentProperties` added property `dataplane_api_endpoint`
  - Model `NginxDeploymentUpdateProperties` added property `network_profile`
  - Model `NginxDeploymentUpdateProperties` added property `nginx_app_protect`
  - Added enum `ActivationState`
  - Added model `DiagnosticItem`
  - Added model `ErrorResponse`
  - Added enum `Level`
  - Added model `NginxConfigurationProtectedFileRequest`
  - Added model `NginxConfigurationProtectedFileResponse`
  - Added model `NginxConfigurationRequest`
  - Added model `NginxConfigurationRequestProperties`
  - Added model `NginxConfigurationResponse`
  - Added model `NginxConfigurationResponseProperties`
  - Added model `NginxDeploymentApiKeyListResponse`
  - Added model `NginxDeploymentApiKeyRequest`
  - Added model `NginxDeploymentApiKeyRequestProperties`
  - Added model `NginxDeploymentApiKeyResponse`
  - Added model `NginxDeploymentApiKeyResponseProperties`
  - Added model `NginxDeploymentPropertiesNginxAppProtect`
  - Added model `NginxDeploymentUpdatePropertiesNginxAppProtect`
  - Added model `WebApplicationFirewallComponentVersions`
  - Added model `WebApplicationFirewallPackage`
  - Added model `WebApplicationFirewallSettings`
  - Added model `WebApplicationFirewallStatus`
  - Added operation group `ApiKeysOperations`

### Breaking Changes

  - Model `NginxDeploymentProperties` deleted or renamed its instance variable `managed_resource_group`
  - Deleted or renamed model `NginxConfiguration`
  - Deleted or renamed model `NginxConfigurationProperties`
  - Deleted or renamed model `ResourceProviderDefaultErrorResponse`

## 3.1.0b1 (2024-03-18)

### Features Added

  - Added operation ConfigurationsOperations.analysis
  - Model NginxCertificateProperties has a new parameter certificate_error
  - Model NginxCertificateProperties has a new parameter key_vault_secret_created
  - Model NginxCertificateProperties has a new parameter key_vault_secret_version
  - Model NginxCertificateProperties has a new parameter sha1_thumbprint
  - Model NginxDeploymentProperties has a new parameter auto_upgrade_profile
  - Model NginxDeploymentScalingProperties has a new parameter profiles
  - Model NginxDeploymentUpdateProperties has a new parameter auto_upgrade_profile

## 3.0.0 (2023-11-20)

### Features Added

  - Model NginxConfigurationPackage has a new parameter protected_files
  - Model NginxDeploymentProperties has a new parameter scaling_properties
  - Model NginxDeploymentProperties has a new parameter user_profile
  - Model NginxDeploymentUpdateProperties has a new parameter scaling_properties
  - Model NginxDeploymentUpdateProperties has a new parameter user_profile

### Breaking Changes

  - Model NginxCertificate no longer has parameter tags
  - Model NginxConfiguration no longer has parameter tags

## 2.1.0 (2023-03-14)

### Other Changes

  - Regular update

## 2.1.0b1 (2022-12-29)

### Other Changes

  - Added generated samples in github repo
  - Drop support for python<3.7.0

## 2.0.0 (2022-10-18)

### Features Added

  - Added operation CertificatesOperations.begin_create_or_update
  - Added operation DeploymentsOperations.begin_create_or_update

### Breaking Changes

  - Removed operation CertificatesOperations.begin_create
  - Removed operation DeploymentsOperations.begin_create

## 1.1.0 (2022-09-20)

### Features Added

  - Model NginxConfigurationProperties has a new parameter protected_files

## 1.0.0 (2022-08-26)

### Features Added

  - Model NginxDeploymentProperties has a new parameter logging
  - Model NginxDeploymentUpdateProperties has a new parameter logging

## 1.0.0b1 (2022-06-13)

* Initial Release