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.
begin_delete	Delete the NGINX deployment resource.
begin_update	Update the NGINX deployment.
get	Get the NGINX deployment.
list	List the NGINX deployments resources.
list_by_resource_group	List all NGINX deployments under the specified resource group.

begin_create_or_update

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 <xref:JSON> or IO[bytes] The Nginx deployment. Is one of the following types: NginxDeployment, JSON, IO[bytes] Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

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.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

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 <xref:JSON> or IO[bytes] The Nginx deployment update parameters. Is one of the following types: NginxDeploymentUpdateParameters, JSON, IO[bytes] Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

get

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.

Returns

Type	Description
NginxDeployment	NginxDeployment. The NginxDeployment is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

List the NGINX deployments resources.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

List all NGINX deployments under the specified resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError