azure-mgmt-nginx 4.0.0

Microsoft Azure Nginx Management Client Library for Python

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

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 NginxManagementClient added parameter cloud_setting in method __init__
• Client NginxManagementClient added method send_request
• Client NginxManagementClient added operation group nginx_deployment_waf_policies
• Client NginxManagementClient added operation group api_keys
• Client NginxManagementClient added operation group waf_policy
• Client NginxManagementClient added operation group default_waf_policy
• Model NginxCertificateProperties added property sha1_thumbprint
• Model NginxCertificateProperties added property key_vault_secret_version
• Model NginxCertificateProperties added property key_vault_secret_created
• Model NginxCertificateProperties added property certificate_error
• Model NginxDeploymentProperties added property auto_upgrade_profile
• Model NginxDeploymentProperties added property nginx_app_protect
• Model NginxDeploymentProperties added property dataplane_api_endpoint
• Model NginxDeploymentScalingProperties added property auto_scale_settings
• Model NginxDeploymentUpdateProperties added property network_profile
• Model NginxDeploymentUpdateProperties added property auto_upgrade_profile
• Model NginxDeploymentUpdateProperties added property nginx_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 ConfigurationsOperations added method analysis
• 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 NginxDeploymentProperties deleted or renamed its instance variable managed_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/NginxDeploymentListResponse which actually were not used by SDK users

3.1.0b3 (2026-02-10)

Features Added

• Model NginxManagementClient added parameter cloud_setting in method __init__
• Client NginxManagementClient added operation group default_waf_policy
• Client NginxManagementClient added operation group waf_policy
• Model AnalysisCreate added property root_file
• Model AnalysisCreate added property files
• Model AnalysisCreate added property protected_files
• Model AnalysisCreate added property package
• Model AnalysisResult added property errors
• Model AnalysisResult added property diagnostics
• Model NginxDeploymentApiKeyRequest added property system_data
• Model NginxDeploymentApiKeyResponse added property system_data
• Model NginxDeploymentProperties added property web_application_firewall_settings
• Model NginxDeploymentProperties added property web_application_firewall_status
• Model NginxDeploymentUpdateProperties added property web_application_firewall_settings
• Model ScaleProfile added property min
• Model ScaleProfile added property max
• Model WebApplicationFirewallStatus added property waf_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 AnalysisCreate deleted or renamed its instance variable config
• Model AnalysisResult deleted or renamed its instance variable data
• Method NginxCertificateListResponse.__init__ removed default value None from its parameter value
• Method NginxConfigurationListResponse.__init__ removed default value None from its parameter value
• Method NginxDeployment.__init__ removed default value None from its parameter location
• Method NginxDeploymentApiKeyListResponse.__init__ removed default value None from its parameter value
• Method NginxDeploymentListResponse.__init__ removed default value None from its parameter value
• Model NginxDeploymentProperties deleted or renamed its instance variable nginx_app_protect
• Model NginxDeploymentUpdateProperties deleted or renamed its instance variable nginx_app_protect
• Model ScaleProfile deleted or renamed its instance variable capacity
• 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 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