Microsoft Azure SDK for Python
This is the Microsoft Azure Nginx Management Client Library. This package has been tested with Python 3.9+. For a more complete view of Azure libraries, see the azure sdk python release.
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.9+ is required to use this package.
- Azure subscription
Install the package
pip install azure-mgmt-nginx
pip install azure-identity
Authentication
By default, Azure Active Directory token authentication depends on correct configuration of the following environment variables.
AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor 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:
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 on docs.microsoft.com
- Azure Python Mgmt SDK Samples Repo
- Other Nginx Management doc
Troubleshooting
Next steps
Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
Release History
4.0.0 (2026-03-18)
Features Added
- Model
NginxManagementClientadded parametercloud_settingin method__init__ - Client
NginxManagementClientadded methodsend_request - Client
NginxManagementClientadded operation groupnginx_deployment_waf_policies - Client
NginxManagementClientadded operation groupapi_keys - Client
NginxManagementClientadded operation groupwaf_policy - Client
NginxManagementClientadded operation groupdefault_waf_policy - Model
NginxCertificatePropertiesadded propertysha1_thumbprint - Model
NginxCertificatePropertiesadded propertykey_vault_secret_version - Model
NginxCertificatePropertiesadded propertykey_vault_secret_created - Model
NginxCertificatePropertiesadded propertycertificate_error - Model
NginxDeploymentPropertiesadded propertyauto_upgrade_profile - Model
NginxDeploymentPropertiesadded propertynginx_app_protect - Model
NginxDeploymentPropertiesadded propertydataplane_api_endpoint - Model
NginxDeploymentScalingPropertiesadded propertyauto_scale_settings - Model
NginxDeploymentUpdatePropertiesadded propertynetwork_profile - Model
NginxDeploymentUpdatePropertiesadded propertyauto_upgrade_profile - Model
NginxDeploymentUpdatePropertiesadded propertynginx_app_protect - Added enum
ActionType - Added enum
ActivationState - Added model
AnalysisCreate - Added model
AnalysisCreateConfig - Added model
AnalysisDiagnostic - Added model
AnalysisResult - Added model
AnalysisResultData - Added model
AutoUpgradeProfile - Added model
DiagnosticItem - Added model
ErrorAdditionalInfo - Added model
ErrorDetail - Added model
ErrorResponse - Added enum
Level - Added model
NginxCertificateErrorResponseBody - Added model
NginxConfigurationProtectedFileRequest - Added model
NginxConfigurationProtectedFileResponse - Added model
NginxConfigurationRequest - Added model
NginxConfigurationRequestProperties - Added model
NginxConfigurationResponse - Added model
NginxConfigurationResponseProperties - Added model
NginxDeploymentApiKeyRequest - Added model
NginxDeploymentApiKeyRequestProperties - Added model
NginxDeploymentApiKeyResponse - Added model
NginxDeploymentApiKeyResponseProperties - Added model
NginxDeploymentDefaultWafPolicyListResponse - Added model
NginxDeploymentDefaultWafPolicyProperties - Added model
NginxDeploymentPropertiesNginxAppProtect - Added model
NginxDeploymentScalingPropertiesAutoScaleSettings - Added model
NginxDeploymentUpdatePropertiesNginxAppProtect - Added model
NginxDeploymentWafPolicy - Added model
NginxDeploymentWafPolicyAnalysisCreateRequest - Added model
NginxDeploymentWafPolicyAnalysisData - Added model
NginxDeploymentWafPolicyAnalysisResponse - Added model
NginxDeploymentWafPolicyApplyingStatus - Added enum
NginxDeploymentWafPolicyApplyingStatusCode - Added model
NginxDeploymentWafPolicyCompilingStatus - Added enum
NginxDeploymentWafPolicyCompilingStatusCode - Added model
NginxDeploymentWafPolicyError - Added model
NginxDeploymentWafPolicyMetadata - Added model
NginxDeploymentWafPolicyMetadataProperties - Added model
NginxDeploymentWafPolicyProperties - Added model
Operation - Added enum
Origin - Added model
ProxyResource - Added model
Resource - Added model
ScaleProfile - Added model
ScaleProfileCapacity - Added model
TrackedResource - Added model
WebApplicationFirewallComponentVersions - Added model
WebApplicationFirewallPackage - Added model
WebApplicationFirewallSettings - Added model
WebApplicationFirewallStatus - Operation group
ConfigurationsOperationsadded methodanalysis - Added operation group
ApiKeysOperations - Added operation group
DefaultWafPolicyOperations - Added operation group
NginxDeploymentWafPoliciesOperations - Added operation group
WafPolicyOperations
Breaking Changes
- This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
- Model
NginxDeploymentPropertiesdeleted or renamed its instance variablemanaged_resource_group - Deleted or renamed model
ErrorResponseBody - Deleted or renamed model
NginxConfiguration - Deleted or renamed model
NginxConfigurationProperties - Deleted or renamed model
OperationResult - Deleted or renamed model
ResourceProviderDefaultErrorResponse
Other Changes
- Deleted models
NginxCertificateListResponse/NginxConfigurationListResponse/NginxDeploymentListResponsewhich actually were not used by SDK users
3.1.0b3 (2026-02-10)
Features Added
- Model
NginxManagementClientadded parametercloud_settingin method__init__ - Client
NginxManagementClientadded operation groupdefault_waf_policy - Client
NginxManagementClientadded operation groupwaf_policy - Model
AnalysisCreateadded propertyroot_file - Model
AnalysisCreateadded propertyfiles - Model
AnalysisCreateadded propertyprotected_files - Model
AnalysisCreateadded propertypackage - Model
AnalysisResultadded propertyerrors - Model
AnalysisResultadded propertydiagnostics - Model
NginxDeploymentApiKeyRequestadded propertysystem_data - Model
NginxDeploymentApiKeyResponseadded propertysystem_data - Model
NginxDeploymentPropertiesadded propertyweb_application_firewall_settings - Model
NginxDeploymentPropertiesadded propertyweb_application_firewall_status - Model
NginxDeploymentUpdatePropertiesadded propertyweb_application_firewall_settings - Model
ScaleProfileadded propertymin - Model
ScaleProfileadded propertymax - Model
WebApplicationFirewallStatusadded propertywaf_release - Added enum
ActionType - Added model
NginxDeploymentDefaultWafPolicyListResponse - Added model
NginxDeploymentDefaultWafPolicyProperties - Added model
NginxDeploymentWafPolicy - Added model
NginxDeploymentWafPolicyApplyingStatus - Added enum
NginxDeploymentWafPolicyApplyingStatusCode - Added model
NginxDeploymentWafPolicyCompilingStatus - Added enum
NginxDeploymentWafPolicyCompilingStatusCode - Added model
NginxDeploymentWafPolicyListResponse - Added model
NginxDeploymentWafPolicyMetadata - Added model
NginxDeploymentWafPolicyMetadataProperties - Added model
NginxDeploymentWafPolicyProperties - Added model
Operation - Added enum
Origin - Added model
ProxyResource - Added model
Resource - Added model
TrackedResource - Added model
DefaultWafPolicyOperations - Added model
WafPolicyOperations
Breaking Changes
- Model
AnalysisCreatedeleted or renamed its instance variableconfig - Model
AnalysisResultdeleted or renamed its instance variabledata - Method
NginxCertificateListResponse.__init__removed default valueNonefrom its parametervalue - Method
NginxConfigurationListResponse.__init__removed default valueNonefrom its parametervalue - Method
NginxDeployment.__init__removed default valueNonefrom its parameterlocation - Method
NginxDeploymentApiKeyListResponse.__init__removed default valueNonefrom its parametervalue - Method
NginxDeploymentListResponse.__init__removed default valueNonefrom its parametervalue - Model
NginxDeploymentPropertiesdeleted or renamed its instance variablenginx_app_protect - Model
NginxDeploymentUpdatePropertiesdeleted or renamed its instance variablenginx_app_protect - Model
ScaleProfiledeleted or renamed its instance variablecapacity - Deleted or renamed model
AnalysisCreateConfig - Deleted or renamed model
AnalysisResultData - Deleted or renamed model
NginxDeploymentPropertiesNginxAppProtect - Deleted or renamed model
NginxDeploymentUpdatePropertiesNginxAppProtect - Deleted or renamed model
OperationResult - Deleted or renamed model
ScaleProfileCapacity
3.1.0b2 (2025-02-23)
Features Added
- Client
NginxManagementClientadded operation groupapi_keys - Model
AnalysisResultDataadded propertydiagnostics - Model
NginxDeploymentPropertiesadded propertynginx_app_protect - Model
NginxDeploymentPropertiesadded propertydataplane_api_endpoint - Model
NginxDeploymentUpdatePropertiesadded propertynetwork_profile - Model
NginxDeploymentUpdatePropertiesadded propertynginx_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
NginxDeploymentPropertiesdeleted or renamed its instance variablemanaged_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
Metadata
Release files for azure-mgmt-nginx 4.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| azure_mgmt_nginx-4.0.0.tar.gz | 76.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| azure_mgmt_nginx-4.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 158.1 kB
Release files / azure_mgmt_nginx-4.0.0.tar.gz
| Download URL | azure_mgmt_nginx-4.0.0.tar.gz |
|---|---|
| Size | 76.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f60ecd2ec2e1d95959ea9f506f4ec6ee34162e95c755ee14b68562cf8ee6d43
|
|
BLAKE2b-256 checksum How to use checksums |
3191b82a756ce3862304378888ef6d3af039c7731592dc163a64d4c28bf0299e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|
Release files / azure_mgmt_nginx-4.0.0-py3-none-any.whl
| Download URL | azure_mgmt_nginx-4.0.0-py3-none-any.whl |
|---|---|
| Size | 82.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e273142174c5e50af5cc6fe4f5bf340f0c4e140c39d75df8718ad0ce891203af
|
|
BLAKE2b-256 checksum How to use checksums |
f25bc2f06853d9cdd2cf87d62af2e3cd3c3032825331810de63175191071dc62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
RestSharp/106.13.0.0
|