CertificatesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NginxManagementClient's

<xref:certificates> attribute.

Constructor

CertificatesOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update the NGINX certificates for given NGINX deployment.
begin_delete	Deletes a certificate from the NGINX deployment.
get	Get a certificate of given NGINX deployment.
list	List all certificates of given NGINX deployment.

begin_create_or_update

Create or update the NGINX certificates for given NGINX deployment.

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

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.
certificate_name Required	str The name of certificate. Required.
body	NginxCertificate or <xref:JSON> or IO[bytes] The certificate. Is one of the following types: NginxCertificate, JSON, IO[bytes] Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a certificate from the NGINX deployment.

begin_delete(resource_group_name: str, deployment_name: str, certificate_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.
certificate_name Required	str The name of certificate. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Get a certificate of given NGINX deployment.

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

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.
certificate_name Required	str The name of certificate. Required.

Returns

Type	Description
NginxCertificate	NginxCertificate. The NginxCertificate is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

List all certificates of given NGINX deployment.

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

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[NginxCertificate]	An iterator like instance of NginxCertificate

Exceptions

Type	Description
HttpResponseError