ConfigurationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NginxManagementClient's

<xref:configurations> attribute.

Inheritance

builtins.object

ConfigurationsOperations

Constructor

ConfigurationsOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update the Nginx configuration for given Nginx deployment. Create or update the Nginx configuration for given Nginx deployment.
begin_delete	Reset the Nginx configuration of given Nginx deployment to default. Reset the Nginx configuration of given Nginx deployment to default.
get	Get the Nginx configuration of given Nginx deployment. Get the Nginx configuration of given Nginx deployment.
list	List the Nginx configuration of given Nginx deployment. List the Nginx configuration of given Nginx deployment.

begin_create_or_update

Create or update the Nginx configuration for given Nginx deployment.

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.NginxConfiguration | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.NginxConfiguration]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive. Required.

deployment_name

str

Required

The name of targeted Nginx deployment. Required.

configuration_name

str

Required

The name of configuration, only 'default' is supported value due to the singleton of Nginx conf. Required.

body

NginxConfiguration or <xref:IO>

Required

The Nginx configuration. Is either a NginxConfiguration type or a IO type. Default value is None.

content_type

str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NginxConfiguration]

Exceptions

HttpResponseError

begin_delete

Reset the Nginx configuration of given Nginx deployment to default.

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

resource_group_name

str

Required

The name of the resource group. The name is case insensitive. Required.

deployment_name

str

Required

The name of targeted Nginx deployment. Required.

configuration_name

str

Required

The name of configuration, only 'default' is supported value due to the singleton of Nginx conf. Required.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

get

Get the Nginx configuration of given Nginx deployment.

Get the Nginx configuration of given Nginx deployment.

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

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive. Required.

deployment_name

str

Required

The name of targeted Nginx deployment. Required.

configuration_name

str

Required

The name of configuration, only 'default' is supported value due to the singleton of Nginx conf. Required.

cls

callable

A custom type or function that will be passed the direct response

Returns

NginxConfiguration or the result of cls(response)

Return type

NginxConfiguration

Exceptions

HttpResponseError

list

List the Nginx configuration of given Nginx deployment.

List the Nginx configuration of given Nginx deployment.

list(resource_group_name: str, deployment_name: str, **kwargs: Any) -> Iterable[NginxConfiguration]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive. Required.

deployment_name

str

Required

The name of targeted Nginx deployment. Required.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[NginxConfiguration]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.nginx.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.3\\x64\\Lib\\site-packages\\azure\\mgmt\\nginx\\models\\__init__.py'>