ConfigurationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NginxManagementClient's

<xref:configurations> attribute.

Constructor

ConfigurationsOperations(*args, **kwargs)

Methods

analysis	Analyze an NGINX configuration without applying it to the NGINXaaS deployment.
begin_create_or_update	Create or update the NGINX configuration for given NGINX deployment.
begin_delete	Reset the NGINX configuration of given NGINX deployment to default.
get	Get the NGINX configuration of given NGINX deployment.
list	List the NGINX configuration of given NGINX deployment.

analysis

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

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_name Required	str The name of targeted NGINX deployment. Required.
configuration_name Required	str The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required.
body	AnalysisCreate or <xref:JSON> or IO[bytes] The NGINX configuration to analyze. Is one of the following types: AnalysisCreate, JSON, IO[bytes] Default value is None. Default value: None

Returns

Type	Description
AnalysisResult	AnalysisResult. The AnalysisResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Create or update the NGINX configuration for given NGINX deployment.

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]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_name Required	str The name of targeted NGINX deployment. Required.
configuration_name Required	str The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required.
body	NginxConfigurationRequest or <xref:JSON> or IO[bytes] The NGINX configuration. Is one of the following types: NginxConfigurationRequest, JSON, IO[bytes] Default value is None. Default value: None

Returns

Type	Description
LROPoller[NginxConfigurationResponse]	An instance of LROPoller that returns NginxConfigurationResponse. The NginxConfigurationResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Reset the NGINX configuration of given NGINX deployment to default.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_name Required	str The name of targeted NGINX deployment. Required.
configuration_name Required	str The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

get

Get the NGINX configuration of given NGINX deployment.

get(resource_group_name: str, deployment_name: str, configuration_name: str, **kwargs: Any) -> NginxConfigurationResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_name Required	str The name of targeted NGINX deployment. Required.
configuration_name Required	str The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required.

Returns

Type	Description
NginxConfigurationResponse	NginxConfigurationResponse. The NginxConfigurationResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

List the NGINX configuration of given NGINX deployment.

list(resource_group_name: str, deployment_name: str, **kwargs: Any) -> ItemPaged[NginxConfigurationResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
deployment_name Required	str The name of targeted NGINX deployment. Required.

Returns

Type	Description
ItemPaged[NginxConfigurationResponse]	An iterator like instance of NginxConfigurationResponse

Exceptions

Type	Description
HttpResponseError