azure.mgmt.nginx.operations module

class azure.mgmt.nginx.operations.ApiKeysOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NginxManagementClient’s api_keys attribute.

create_or_update(resource_group_name: str, deployment_name: str, api_key_name: str, body: _models.NginxDeploymentApiKeyRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.NginxDeploymentApiKeyResponse[source]
create_or_update(resource_group_name: str, deployment_name: str, api_key_name: str, body: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.NginxDeploymentApiKeyResponse

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint.

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • api_key_name (str) – The resource name of the API key. Required.

  • body (NginxDeploymentApiKeyRequest or IO[bytes]) – The API Key object containing fields (e.g. secret text, expiration date) to upsert the key. Is either a NginxDeploymentApiKeyRequest type or a IO[bytes] type. Default value is None.

Returns:

NginxDeploymentApiKeyResponse or the result of cls(response)

Return type:

NginxDeploymentApiKeyResponse

Raises:

HttpResponseError –

delete(resource_group_name: str, deployment_name: str, api_key_name: str, **kwargs: Any) → None[source]

Delete API key for Nginx deployment.

Delete API key for Nginx deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • api_key_name (str) – The resource name of the API key. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, deployment_name: str, api_key_name: str, **kwargs: Any) → NginxDeploymentApiKeyResponse[source]

Get the specified API Key of the given Nginx deployment.

Get the specified API Key of the given Nginx deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • api_key_name (str) – The resource name of the API key. Required.

Returns:

NginxDeploymentApiKeyResponse or the result of cls(response)

Return type:

NginxDeploymentApiKeyResponse

Raises:

HttpResponseError –

list(resource_group_name: str, deployment_name: str, **kwargs: Any) → Iterable[NginxDeploymentApiKeyResponse][source]

List all API Keys of the given Nginx deployment.

List all API Keys of the given Nginx deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

Returns:

An iterator like instance of either NginxDeploymentApiKeyResponse or the result of cls(response)

Return type:

ItemPaged[NginxDeploymentApiKeyResponse]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.nginx.models' from '/mnt/vss/_work/1/s/sdk/nginx/azure-mgmt-nginx/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/nginx/models/__init__.py'>
class azure.mgmt.nginx.operations.CertificatesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NginxManagementClient’s certificates attribute.

begin_create_or_update(resource_group_name: str, deployment_name: str, certificate_name: str, body: _models.NginxCertificate | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxCertificate][source]
begin_create_or_update(resource_group_name: str, deployment_name: str, certificate_name: str, body: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxCertificate]

Create or update the NGINX certificates for given NGINX deployment.

Create or update the NGINX certificates for given NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • certificate_name (str) – The name of certificate. Required.

  • body (NginxCertificate or IO[bytes]) – The certificate. Is either a NginxCertificate type or a IO[bytes] type. Default value is None.

Returns:

An instance of LROPoller that returns either NginxCertificate or the result of cls(response)

Return type:

LROPoller[NginxCertificate]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, deployment_name: str, certificate_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a certificate from the NGINX deployment.

Deletes a certificate from the NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • certificate_name (str) – The name of certificate. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, deployment_name: str, certificate_name: str, **kwargs: Any) → NginxCertificate[source]

Get a certificate of given NGINX deployment.

Get a certificate of given NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • certificate_name (str) – The name of certificate. Required.

Returns:

NginxCertificate or the result of cls(response)

Return type:

NginxCertificate

Raises:

HttpResponseError –

list(resource_group_name: str, deployment_name: str, **kwargs: Any) → Iterable[NginxCertificate][source]

List all certificates of given NGINX deployment.

List all certificates of given NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

Returns:

An iterator like instance of either NginxCertificate or the result of cls(response)

Return type:

ItemPaged[NginxCertificate]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.nginx.models' from '/mnt/vss/_work/1/s/sdk/nginx/azure-mgmt-nginx/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/nginx/models/__init__.py'>
class azure.mgmt.nginx.operations.ConfigurationsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NginxManagementClient’s configurations attribute.

analysis(resource_group_name: str, deployment_name: str, configuration_name: str, body: _models.AnalysisCreate | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.AnalysisResult[source]
analysis(resource_group_name: str, deployment_name: str, configuration_name: str, body: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.AnalysisResult

Analyze an NGINX configuration without applying it to the NGINXaaS deployment.

Analyze an NGINX configuration without applying it to the NGINXaaS deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • configuration_name (str) – The name of configuration, only ‘default’ is supported value due to the singleton of NGINX conf. Required.

  • body (AnalysisCreate or IO[bytes]) – The NGINX configuration to analyze. Is either a AnalysisCreate type or a IO[bytes] type. Default value is None.

Returns:

AnalysisResult or the result of cls(response)

Return type:

AnalysisResult

Raises:

HttpResponseError –

begin_create_or_update(resource_group_name: str, deployment_name: str, configuration_name: str, body: _models.NginxConfigurationRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxConfigurationResponse][source]
begin_create_or_update(resource_group_name: str, deployment_name: str, configuration_name: str, body: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxConfigurationResponse]

Create or update the NGINX configuration for given NGINX deployment.

Create or update the NGINX configuration for given NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • configuration_name (str) – The name of configuration, only ‘default’ is supported value due to the singleton of NGINX conf. Required.

  • body (NginxConfigurationRequest or IO[bytes]) – The NGINX configuration. Is either a NginxConfigurationRequest type or a IO[bytes] type. Default value is None.

Returns:

An instance of LROPoller that returns either NginxConfigurationResponse or the result of cls(response)

Return type:

LROPoller[NginxConfigurationResponse]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, deployment_name: str, configuration_name: str, **kwargs: Any) → LROPoller[None][source]

Reset the NGINX configuration of given NGINX deployment to default.

Reset the NGINX configuration of given NGINX deployment to default.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • configuration_name (str) – The name of configuration, only ‘default’ is supported value due to the singleton of NGINX conf. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, deployment_name: str, configuration_name: str, **kwargs: Any) → NginxConfigurationResponse[source]

Get the NGINX configuration of given NGINX deployment.

Get the NGINX configuration of given NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • configuration_name (str) – The name of configuration, only ‘default’ is supported value due to the singleton of NGINX conf. Required.

Returns:

NginxConfigurationResponse or the result of cls(response)

Return type:

NginxConfigurationResponse

Raises:

HttpResponseError –

list(resource_group_name: str, deployment_name: str, **kwargs: Any) → Iterable[NginxConfigurationResponse][source]

List the NGINX configuration of given NGINX deployment.

List the NGINX configuration of given NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

Returns:

An iterator like instance of either NginxConfigurationResponse or the result of cls(response)

Return type:

ItemPaged[NginxConfigurationResponse]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.nginx.models' from '/mnt/vss/_work/1/s/sdk/nginx/azure-mgmt-nginx/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/nginx/models/__init__.py'>
class azure.mgmt.nginx.operations.DeploymentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NginxManagementClient’s deployments attribute.

begin_create_or_update(resource_group_name: str, deployment_name: str, body: _models.NginxDeployment | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxDeployment][source]
begin_create_or_update(resource_group_name: str, deployment_name: str, body: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxDeployment]

Create or update the NGINX deployment.

Create or update the NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • body (NginxDeployment or IO[bytes]) – Is either a NginxDeployment type or a IO[bytes] type. Default value is None.

Returns:

An instance of LROPoller that returns either NginxDeployment or the result of cls(response)

Return type:

LROPoller[NginxDeployment]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, deployment_name: str, **kwargs: Any) → LROPoller[None][source]

Delete the NGINX deployment resource.

Delete the NGINX deployment resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, deployment_name: str, body: _models.NginxDeploymentUpdateParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxDeployment][source]
begin_update(resource_group_name: str, deployment_name: str, body: IO[bytes] | None = None, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.NginxDeployment]

Update the NGINX deployment.

Update the NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

  • body (NginxDeploymentUpdateParameters or IO[bytes]) – Is either a NginxDeploymentUpdateParameters type or a IO[bytes] type. Default value is None.

Returns:

An instance of LROPoller that returns either NginxDeployment or the result of cls(response)

Return type:

LROPoller[NginxDeployment]

Raises:

HttpResponseError –

get(resource_group_name: str, deployment_name: str, **kwargs: Any) → NginxDeployment[source]

Get the NGINX deployment.

Get the NGINX deployment.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • deployment_name (str) – The name of targeted NGINX deployment. Required.

Returns:

NginxDeployment or the result of cls(response)

Return type:

NginxDeployment

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[NginxDeployment][source]

List the NGINX deployments resources.

List the NGINX deployments resources.

Returns:

An iterator like instance of either NginxDeployment or the result of cls(response)

Return type:

ItemPaged[NginxDeployment]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[NginxDeployment][source]

List all NGINX deployments under the specified resource group.

List all NGINX deployments under the specified resource group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Returns:

An iterator like instance of either NginxDeployment or the result of cls(response)

Return type:

ItemPaged[NginxDeployment]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.nginx.models' from '/mnt/vss/_work/1/s/sdk/nginx/azure-mgmt-nginx/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/nginx/models/__init__.py'>
class azure.mgmt.nginx.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through NginxManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[OperationResult][source]

List all operations provided by Nginx.NginxPlus for the 2024-11-01-preview api version.

List all operations provided by Nginx.NginxPlus for the 2024-11-01-preview api version.

Returns:

An iterator like instance of either OperationResult or the result of cls(response)

Return type:

ItemPaged[OperationResult]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.nginx.models' from '/mnt/vss/_work/1/s/sdk/nginx/azure-mgmt-nginx/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/nginx/models/__init__.py'>