ConfigurationsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:configurations> attribute.
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
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
deployment_name
Required
|
The name of targeted NGINX deployment. Required. |
configuration_name
Required
|
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required. |
body
|
The NGINX configuration. Is either a NginxConfiguration type or a IO type. Default value is None. Default value: None
|
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either NginxConfiguration or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
deployment_name
Required
|
The name of targeted NGINX deployment. Required. |
configuration_name
Required
|
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
deployment_name
Required
|
The name of targeted NGINX deployment. Required. |
configuration_name
Required
|
The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
NginxConfiguration or the result of cls(response) |
Exceptions
Type | Description |
---|---|
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
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
deployment_name
Required
|
The name of targeted NGINX deployment. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either NginxConfiguration or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.nginx.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv170\\Lib\\site-packages\\azure\\mgmt\\nginx\\models\\__init__.py'>
Azure SDK for Python