Share via

CertificatesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:certificates> attribute.

Inheritance
builtins.object
CertificatesOperations

Constructor

CertificatesOperations(*args, **kwargs)

Methods

create_or_update

Create or update a certificate.

Description for Create or update a certificate.
delete

Delete a certificate.

Description for Delete a certificate.
get

Get a certificate.

Description for Get a certificate.
list

Get all certificates for a subscription.

Description for Get all certificates for a subscription.
list_by_resource_group

Get all certificates in a resource group.

Description for Get all certificates in a resource group.
update

Create or update a certificate.

Description for Create or update a certificate.

create_or_update

Create or update a certificate.

Description for Create or update a certificate.

create_or_update(resource_group_name: str, name: str, certificate_envelope: _models.Certificate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Certificate

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the certificate. Required.
certificate_envelope
Required
Certificate or IO[bytes]

Details of certificate, if it exists already. Is either a Certificate type or a IO[bytes] type. Required.

Returns

Type Description
Certificate

Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete a certificate.

Description for Delete a certificate.

delete(resource_group_name: str, name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the certificate. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a certificate.

Description for Get a certificate.

get(resource_group_name: str, name: str, **kwargs: Any) -> Certificate

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the certificate. Required.

Returns

Type Description
Certificate

Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Get all certificates for a subscription.

Description for Get all certificates for a subscription.

list(filter: str | None = None, **kwargs: Any) -> Iterable[Certificate]

Parameters

Name Description
filter
Required
str

Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'. Default value is None.

Returns

Type Description
ItemPaged[Certificate]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Get all certificates in a resource group.

Description for Get all certificates in a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.

Returns

Type Description
ItemPaged[Certificate]

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

Exceptions

Type Description
HttpResponseError

update

Create or update a certificate.

Description for Create or update a certificate.

update(resource_group_name: str, name: str, certificate_envelope: _models.CertificatePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Certificate

Parameters

Name Description
resource_group_name
Required
str

Name of the resource group to which the resource belongs. Required.
name
Required
str

Name of the certificate. Required.
certificate_envelope
Required
CertificatePatchResource or IO[bytes]

Details of certificate, if it exists already. Is either a CertificatePatchResource type or a IO[bytes] type. Required.

Returns

Type Description
Certificate

Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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