Share via

DeploymentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NginxManagementClient's

<xref:deployments> attribute.

Constructor

DeploymentsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update the NGINX deployment.

Create or update the NGINX deployment.
begin_delete

Delete the NGINX deployment resource.

Delete the NGINX deployment resource.
begin_update

Update the NGINX deployment.

Update the NGINX deployment.
get

Get the NGINX deployment.

Get the NGINX deployment.
list

List the NGINX deployments resources.

List the NGINX deployments resources.
list_by_resource_group

List all NGINX deployments under the specified resource group.

List all NGINX deployments under the specified resource group.

begin_create_or_update

Create or update the NGINX deployment.

Create or update the NGINX deployment.

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]

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.
body
NginxDeployment or IO

Is either a NginxDeployment type or a IO type. Default value is None.

Default value: None

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[NginxDeployment]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete the NGINX deployment resource.

Delete the NGINX deployment resource.

begin_delete(resource_group_name: str, deployment_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.

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Update the NGINX deployment.

Update the NGINX deployment.

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

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.
body
NginxDeploymentUpdateParameters or IO

Is either a NginxDeploymentUpdateParameters type or a IO type. Default value is None.

Default value: None

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[NginxDeployment]

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

Exceptions

Type Description
HttpResponseError

get

Get the NGINX deployment.

Get the NGINX deployment.

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

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.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
NginxDeployment

NginxDeployment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List the NGINX deployments resources.

List the NGINX deployments resources.

list(**kwargs: Any) -> Iterable[NginxDeployment]

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[NginxDeployment]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

List all NGINX deployments under the specified resource group.

List all NGINX deployments under the specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[NginxDeployment]

Parameters

Name Description
resource_group_name
Required
str

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

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[NginxDeployment]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.nginx.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv181\\Lib\\site-packages\\azure\\mgmt\\nginx\\models\\__init__.py'>