Skip to content

[AutoPR azure-mgmt-nginx] Added 2025-03-01-preview swagger for Nginx.NginxPlus #11699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
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
54 changes: 54 additions & 0 deletions sdk/nginx/azure-mgmt-nginx/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,59 @@
# Release History

## 3.1.0b3 (2025-05-12)

### Features Added

- Client `NginxManagementClient` added operation group `waf_policy`
- Client `NginxManagementClient` added operation group `default_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 model `OperationDisplayAutoGenerated`
- Added enum `Origin`
- Added model `DefaultWafPolicyOperations`
- Added model `WafPolicyOperations`
- Method `WafPolicyOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, deployment_name: str, waf_policy_name: str, body: Optional[NginxDeploymentWafPolicy], content_type: str)`
- Method `WafPolicyOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, deployment_name: str, waf_policy_name: str, body: Optional[IO[bytes]], content_type: str)`

### Breaking Changes

- Model `AnalysisCreate` deleted or renamed its instance variable `config`
- Model `AnalysisResult` deleted or renamed its instance variable `data`
- Model `NginxCertificate` deleted or renamed its instance variable `location`
- 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 `ScaleProfileCapacity`

## 3.1.0b2 (2025-02-23)

### Features Added
Expand Down
6 changes: 3 additions & 3 deletions sdk/nginx/azure-mgmt-nginx/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Microsoft Azure SDK for Python

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

## _Disclaimer_
Expand All @@ -12,7 +12,7 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For

### Prerequisites

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

### Install the package
Expand All @@ -24,7 +24,7 @@ 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.
By default, [Azure Active Directory](https://aka.ms/awps/aad) 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.
Expand Down
6 changes: 3 additions & 3 deletions sdk/nginx/azure-mgmt-nginx/_meta.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"commit": "198ffdb2b788b49be283a388ad9735b0cfad1be1",
"commit": "6d1096f0adac674f2cfd8627e24f0354a4fa4308",
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
"autorest": "3.10.2",
"use": [
"@autorest/python@6.27.4",
"@autorest/python@6.34.1",
"@autorest/[email protected]"
],
"autorest_command": "autorest specification/nginx/resource-manager/readme.md --generate-sample=True --generate-test=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/azure-sdk-for-python/sdk --use=@autorest/python@6.27.4 --use=@autorest/[email protected] --version=3.10.2 --version-tolerant=False",
"autorest_command": "autorest specification/nginx/resource-manager/readme.md --generate-sample=True --generate-test=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/python@6.34.1 --use=@autorest/[email protected] --version=3.10.2 --version-tolerant=False",
"readme": "specification/nginx/resource-manager/readme.md"
}
4 changes: 2 additions & 2 deletions sdk/nginx/azure-mgmt-nginx/azure/mgmt/nginx/_configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ class NginxManagementClientConfiguration: # pylint: disable=too-many-instance-a
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
:keyword api_version: Api Version. Default value is "2025-03-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
"""

def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs: Any) -> None:
api_version: str = kwargs.pop("api_version", "2024-11-01-preview")
api_version: str = kwargs.pop("api_version", "2025-03-01-preview")

if credential is None:
raise ValueError("Parameter 'credential' must not be None.")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,34 @@
# --------------------------------------------------------------------------

from copy import deepcopy
from typing import Any, TYPE_CHECKING
from typing import Any, Optional, TYPE_CHECKING, cast
from typing_extensions import Self

from azure.core.pipeline import policies
from azure.core.rest import HttpRequest, HttpResponse
from azure.core.settings import settings
from azure.mgmt.core import ARMPipelineClient
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
from azure.mgmt.core.tools import get_arm_endpoints

from . import models as _models
from ._configuration import NginxManagementClientConfiguration
from ._serialization import Deserializer, Serializer
from ._utils.serialization import Deserializer, Serializer
from .operations import (
ApiKeysOperations,
CertificatesOperations,
ConfigurationsOperations,
DefaultWafPolicyOperations,
DeploymentsOperations,
Operations,
WafPolicyOperations,
)

if TYPE_CHECKING:
from azure.core.credentials import TokenCredential


class NginxManagementClient:
class NginxManagementClient: # pylint: disable=too-many-instance-attributes
"""NginxManagementClient.

:ivar api_keys: ApiKeysOperations operations
Expand All @@ -41,31 +45,37 @@ class NginxManagementClient:
:vartype configurations: azure.mgmt.nginx.operations.ConfigurationsOperations
:ivar deployments: DeploymentsOperations operations
:vartype deployments: azure.mgmt.nginx.operations.DeploymentsOperations
:ivar waf_policy: WafPolicyOperations operations
:vartype waf_policy: azure.mgmt.nginx.operations.WafPolicyOperations
:ivar default_waf_policy: DefaultWafPolicyOperations operations
:vartype default_waf_policy: azure.mgmt.nginx.operations.DefaultWafPolicyOperations
:ivar operations: Operations operations
:vartype operations: azure.mgmt.nginx.operations.Operations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the target subscription. The value must be an UUID. Required.
:type subscription_id: str
:param base_url: Service URL. Default value is "https://management.azure.com".
:param base_url: Service URL. Default value is None.
:type base_url: str
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
:keyword api_version: Api Version. Default value is "2025-03-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
"""

def __init__(
self,
credential: "TokenCredential",
subscription_id: str,
base_url: str = "https://management.azure.com",
**kwargs: Any
self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any
) -> None:
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
_endpoints = get_arm_endpoints(_cloud)
if not base_url:
base_url = _endpoints["resource_manager"]
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
self._config = NginxManagementClientConfiguration(
credential=credential, subscription_id=subscription_id, **kwargs
credential=credential, subscription_id=subscription_id, credential_scopes=credential_scopes, **kwargs
)

_policies = kwargs.pop("policies", None)
if _policies is None:
_policies = [
Expand All @@ -84,7 +94,7 @@ def __init__(
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
self._config.http_logging_policy,
]
self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, policies=_policies, **kwargs)
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, base_url), policies=_policies, **kwargs)

client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)}
self._serialize = Serializer(client_models)
Expand All @@ -94,6 +104,10 @@ def __init__(
self.certificates = CertificatesOperations(self._client, self._config, self._serialize, self._deserialize)
self.configurations = ConfigurationsOperations(self._client, self._config, self._serialize, self._deserialize)
self.deployments = DeploymentsOperations(self._client, self._config, self._serialize, self._deserialize)
self.waf_policy = WafPolicyOperations(self._client, self._config, self._serialize, self._deserialize)
self.default_waf_policy = DefaultWafPolicyOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.operations = Operations(self._client, self._config, self._serialize, self._deserialize)

def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
Loading