AppServiceCertificateOrdersOperations Class

AppServiceCertificateOrdersOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
AppServiceCertificateOrdersOperations

Constructor

AppServiceCertificateOrdersOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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

Verify domain ownership for this certificate order.

Verify domain ownership for this 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

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

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: azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrder, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrder]

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

certificate_distinguished_name
AppServiceCertificateOrder
Required

Distinguished name to use for the certificate order.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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

An instance of AsyncLROPoller that returns either AppServiceCertificateOrder or the result of cls(response)

Return type

Exceptions

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: azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateResource]

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

name
str
Required

Name of the certificate.

key_vault_certificate
AppServiceCertificateResource
Required

Key vault certificate resource Id.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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

An instance of AsyncLROPoller that returns either AppServiceCertificateResource or the result of cls(response)

Return type

Exceptions

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

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

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

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

name
str
Required

Name of the certificate.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Get a certificate order.

Get a certificate order.

async get(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrder

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order..

cls
callable

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

Returns

AppServiceCertificateOrder, or the result of cls(response)

Return type

Exceptions

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) -> azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateResource

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

name
str
Required

Name of the certificate.

cls
callable

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

Returns

AppServiceCertificateResource, or the result of cls(response)

Return type

Exceptions

list

List all certificate orders in a subscription.

List all certificate orders in a subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrderCollection]

Parameters

cls
callable

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

Returns

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

Return type

Exceptions

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[azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrderCollection]

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

cls
callable

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

Returns

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

Return type

Exceptions

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[azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateCollection]

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

cls
callable

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

Returns

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

Return type

Exceptions

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: azure.mgmt.web.v2015_08_01.models._models_py3.ReissueCertificateOrderRequest, **kwargs: Any) -> None

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

reissue_certificate_order_request
ReissueCertificateOrderRequest
Required

Parameters for the reissue.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

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: azure.mgmt.web.v2015_08_01.models._models_py3.RenewCertificateOrderRequest, **kwargs: Any) -> None

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

renew_certificate_order_request
RenewCertificateOrderRequest
Required

Renew parameters.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

resend_email

Resend certificate email.

Resend certificate email.

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

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

resend_request_emails

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

async resend_request_emails(resource_group_name: str, certificate_order_name: str, name_identifier: azure.mgmt.web.v2015_08_01.models._models_py3.NameIdentifier, **kwargs: Any) -> None

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

name_identifier
NameIdentifier
Required

Email address.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

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[azure.mgmt.web.v2015_08_01.models._models_py3.CertificateOrderAction]

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the certificate order.

cls
callable

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

Returns

list of CertificateOrderAction, or the result of cls(response)

Return type

Exceptions

retrieve_certificate_email_history

Retrieve email history.

Retrieve email history.

async retrieve_certificate_email_history(resource_group_name: str, name: str, **kwargs: Any) -> List[azure.mgmt.web.v2015_08_01.models._models_py3.CertificateEmail]

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

name
str
Required

Name of the certificate order.

cls
callable

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

Returns

list of CertificateEmail, or the result of cls(response)

Return type

Exceptions

retrieve_site_seal

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

async retrieve_site_seal(resource_group_name: str, certificate_order_name: str, site_seal_request: azure.mgmt.web.v2015_08_01.models._models_py3.SiteSealRequest, **kwargs: Any) -> azure.mgmt.web.v2015_08_01.models._models_py3.SiteSeal

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

site_seal_request
SiteSealRequest
Required

Site seal request.

cls
callable

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

Returns

SiteSeal, or the result of cls(response)

Return type

Exceptions

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: azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrderPatchResource, **kwargs: Any) -> azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrder

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

certificate_distinguished_name
AppServiceCertificateOrderPatchResource
Required

Distinguished name to use for the certificate order.

cls
callable

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

Returns

AppServiceCertificateOrder, or the result of cls(response)

Return type

Exceptions

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: azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificatePatchResource, **kwargs: Any) -> azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateResource

Parameters

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

name
str
Required

Name of the certificate.

key_vault_certificate
AppServiceCertificatePatchResource
Required

Key vault certificate resource Id.

cls
callable

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

Returns

AppServiceCertificateResource, or the result of cls(response)

Return type

Exceptions

validate_purchase_information

Validate information for a certificate order.

Validate information for a certificate order.

async validate_purchase_information(app_service_certificate_order: azure.mgmt.web.v2015_08_01.models._models_py3.AppServiceCertificateOrder, **kwargs: Any) -> None

Parameters

app_service_certificate_order
AppServiceCertificateOrder
Required

Information for a certificate order.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

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

resource_group_name
str
Required

Name of the resource group to which the resource belongs.

certificate_order_name
str
Required

Name of the certificate order.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.web.v2015_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\web\\v2015_08_01\\models\\__init__.py'>