AppServiceCertificateOrdersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

WebSiteManagementClient's

<xref:app_service_certificate_orders> attribute.

Inheritance

builtins.object

AppServiceCertificateOrdersOperations

Constructor

AppServiceCertificateOrdersOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update a certificate purchase order. Create or update a certificate purchase order.
begin_create_or_update_certificate	Creates or updates a certificate and associates with key vault secret. Creates or updates a certificate and associates with key vault secret.
delete	Delete an existing certificate order. Delete an existing certificate order.
delete_certificate	Delete the certificate associated with a certificate order. Delete the certificate associated with a certificate order.
get	Get a certificate order. Get a certificate order.
get_certificate	Get the certificate associated with a certificate order. Get the certificate associated with a certificate order.
list	List all certificate orders in a subscription. List all certificate orders in a subscription.
list_by_resource_group	Get certificate orders in a resource group. Get certificate orders in a resource group.
list_certificates	List all certificates associated with a certificate order. List all certificates associated with a certificate order.
reissue	Reissue an existing certificate order. Reissue an existing certificate order.
renew	Renew an existing certificate order. Renew an existing certificate order.
resend_email	Resend certificate email. Resend certificate email.
resend_request_emails	Resend domain verification email to customer for this certificate order. Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order.
retrieve_certificate_actions	Retrieve the list of certificate actions. Retrieve the list of certificate actions.
retrieve_certificate_email_history	Retrieve email history. Retrieve email history.
retrieve_site_seal	This method is used to obtain the site seal information for an issued certificate. This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted by the reseller, to minimize delays for customer page load times.
update	Create or update a certificate purchase order. Create or update a certificate purchase order.
update_certificate	Creates or updates a certificate and associates with key vault secret. Creates or updates a certificate and associates with key vault secret.
validate_purchase_information	Validate information for a certificate order. Validate information for a certificate order.
verify_domain_ownership	Verify domain ownership for this certificate order. Verify domain ownership for this certificate order.

begin_create_or_update

Create or update a certificate purchase order.

Create or update a certificate purchase order.

async begin_create_or_update(resource_group_name: str, certificate_order_name: str, certificate_distinguished_name: _models.AppServiceCertificateOrder, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.AppServiceCertificateOrder]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
certificate_distinguished_name Required	AppServiceCertificateOrder or IO[bytes] Distinguished name to use for the certificate order. Is either a AppServiceCertificateOrder type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[AppServiceCertificateOrder]	An instance of AsyncLROPoller that returns either AppServiceCertificateOrder or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update_certificate

Creates or updates a certificate and associates with key vault secret.

Creates or updates a certificate and associates with key vault secret.

async begin_create_or_update_certificate(resource_group_name: str, certificate_order_name: str, name: str, key_vault_certificate: _models.AppServiceCertificateResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.AppServiceCertificateResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
name Required	str Name of the certificate. Required.
key_vault_certificate Required	AppServiceCertificateResource or IO[bytes] Key vault certificate resource Id. Is either a AppServiceCertificateResource type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[AppServiceCertificateResource]	An instance of AsyncLROPoller that returns either AppServiceCertificateResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete an existing certificate order.

Delete an existing certificate order.

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

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete_certificate

Delete the certificate associated with a certificate order.

Delete the certificate associated with a certificate order.

async delete_certificate(resource_group_name: str, certificate_order_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.
certificate_order_name Required	str Name of the certificate order. 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 order.

Get a certificate order.

async get(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> AppServiceCertificateOrder

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order.. Required.

Returns

Type	Description
AppServiceCertificateOrder	AppServiceCertificateOrder or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_certificate

Get the certificate associated with a certificate order.

Get the certificate associated with a certificate order.

async get_certificate(resource_group_name: str, certificate_order_name: str, name: str, **kwargs: Any) -> AppServiceCertificateResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
name Required	str Name of the certificate. Required.

Returns

Type	Description
AppServiceCertificateResource	AppServiceCertificateResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

List all certificate orders in a subscription.

List all certificate orders in a subscription.

list(**kwargs: Any) -> AsyncIterable[AppServiceCertificateOrder]

Returns

Type	Description
AsyncItemPaged[AppServiceCertificateOrder]	An iterator like instance of either AppServiceCertificateOrder or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get certificate orders in a resource group.

Get certificate orders in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[AppServiceCertificateOrder]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.

Returns

Type	Description
AsyncItemPaged[AppServiceCertificateOrder]	An iterator like instance of either AppServiceCertificateOrder or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_certificates

List all certificates associated with a certificate order.

List all certificates associated with a certificate order.

list_certificates(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> AsyncIterable[AppServiceCertificateResource]

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.

Returns

Type	Description
AsyncItemPaged[AppServiceCertificateResource]	An iterator like instance of either AppServiceCertificateResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

reissue

Reissue an existing certificate order.

Reissue an existing certificate order.

async reissue(resource_group_name: str, certificate_order_name: str, reissue_certificate_order_request: _models.ReissueCertificateOrderRequest, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
reissue_certificate_order_request Required	ReissueCertificateOrderRequest or IO[bytes] Parameters for the reissue. Is either a ReissueCertificateOrderRequest type or a IO[bytes] type. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

renew

Renew an existing certificate order.

Renew an existing certificate order.

async renew(resource_group_name: str, certificate_order_name: str, renew_certificate_order_request: _models.RenewCertificateOrderRequest, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
renew_certificate_order_request Required	RenewCertificateOrderRequest or IO[bytes] Renew parameters. Is either a RenewCertificateOrderRequest type or a IO[bytes] type. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

resend_email

Resend certificate email.

Resend certificate email.

async resend_email(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

resend_request_emails

Resend domain verification email to customer for this certificate order.

Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order.

async resend_request_emails(resource_group_name: str, certificate_order_name: str, name_identifier: _models.NameIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
name_identifier Required	NameIdentifier or IO[bytes] Email address. Is either a NameIdentifier type or a IO[bytes] type. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

retrieve_certificate_actions

Retrieve the list of certificate actions.

Retrieve the list of certificate actions.

async retrieve_certificate_actions(resource_group_name: str, name: str, **kwargs: Any) -> List[CertificateOrderAction]

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 order. Required.

Returns

Type	Description
list[CertificateOrderAction]	list of CertificateOrderAction or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

retrieve_certificate_email_history

Retrieve email history.

Retrieve email history.

async retrieve_certificate_email_history(resource_group_name: str, name: str, **kwargs: Any) -> List[CertificateEmail]

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 order. Required.

Returns

Type	Description
list[CertificateEmail]	list of CertificateEmail or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

retrieve_site_seal

This method is used to obtain the site seal information for an issued certificate.

This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted by the reseller, to minimize delays for customer page load times.

async retrieve_site_seal(resource_group_name: str, certificate_order_name: str, site_seal_request: _models.SiteSealRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteSeal

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
site_seal_request Required	SiteSealRequest or IO[bytes] Site seal request. Is either a SiteSealRequest type or a IO[bytes] type. Required.

Returns

Type	Description
SiteSeal	SiteSeal or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Create or update a certificate purchase order.

Create or update a certificate purchase order.

async update(resource_group_name: str, certificate_order_name: str, certificate_distinguished_name: _models.AppServiceCertificateOrderPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AppServiceCertificateOrder

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
certificate_distinguished_name Required	AppServiceCertificateOrderPatchResource or IO[bytes] Distinguished name to use for the certificate order. Is either a AppServiceCertificateOrderPatchResource type or a IO[bytes] type. Required.

Returns

Type	Description
AppServiceCertificateOrder	AppServiceCertificateOrder or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_certificate

Creates or updates a certificate and associates with key vault secret.

Creates or updates a certificate and associates with key vault secret.

async update_certificate(resource_group_name: str, certificate_order_name: str, name: str, key_vault_certificate: _models.AppServiceCertificatePatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AppServiceCertificateResource

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.
name Required	str Name of the certificate. Required.
key_vault_certificate Required	AppServiceCertificatePatchResource or IO[bytes] Key vault certificate resource Id. Is either a AppServiceCertificatePatchResource type or a IO[bytes] type. Required.

Returns

Type	Description
AppServiceCertificateResource	AppServiceCertificateResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

validate_purchase_information

Validate information for a certificate order.

Validate information for a certificate order.

async validate_purchase_information(app_service_certificate_order: _models.AppServiceCertificateOrder, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parameters

Name	Description
app_service_certificate_order Required	AppServiceCertificateOrder or IO[bytes] Information for a certificate order. Is either a AppServiceCertificateOrder type or a IO[bytes] type. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

verify_domain_ownership

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

async verify_domain_ownership(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str Name of the resource group to which the resource belongs. Required.
certificate_order_name Required	str Name of the certificate order. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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