AppServiceCertificateOrdersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:app_service_certificate_orders> attribute.
- Inheritance
-
builtins.objectAppServiceCertificateOrdersOperations
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 |
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.
begin_create_or_update(resource_group_name: str, certificate_order_name: str, certificate_distinguished_name: _models.AppServiceCertificateOrder, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AppServiceCertificateOrder]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
certificate_distinguished_name
Required
|
Distinguished name to use for the certificate order. Is either a AppServiceCertificateOrder type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either AppServiceCertificateOrder or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.
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) -> LROPoller[_models.AppServiceCertificateResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
name
Required
|
Name of the certificate. Required. |
|
key_vault_certificate
Required
|
Key vault certificate resource Id. Is either a AppServiceCertificateResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either AppServiceCertificateResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Delete an existing certificate order.
Delete an existing certificate order.
delete(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_certificate
Delete the certificate associated with a certificate order.
Delete the certificate associated with a certificate order.
delete_certificate(resource_group_name: str, certificate_order_name: str, name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
name
Required
|
Name of the certificate. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a certificate order.
Get a certificate order.
get(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> AppServiceCertificateOrderParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order.. Required. |
Returns
| Type | Description |
|---|---|
|
AppServiceCertificateOrder or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_certificate
Get the certificate associated with a certificate order.
Get the certificate associated with a certificate order.
get_certificate(resource_group_name: str, certificate_order_name: str, name: str, **kwargs: Any) -> AppServiceCertificateResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
name
Required
|
Name of the certificate. Required. |
Returns
| Type | Description |
|---|---|
|
AppServiceCertificateResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
List all certificate orders in a subscription.
List all certificate orders in a subscription.
list(**kwargs: Any) -> Iterable[AppServiceCertificateOrder]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either AppServiceCertificateOrder or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[AppServiceCertificateOrder]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either AppServiceCertificateOrder or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[AppServiceCertificateResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either AppServiceCertificateResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
reissue
Reissue an existing certificate order.
Reissue an existing certificate order.
reissue(resource_group_name: str, certificate_order_name: str, reissue_certificate_order_request: _models.ReissueCertificateOrderRequest, *, content_type: str = 'application/json', **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
reissue_certificate_order_request
Required
|
Parameters for the reissue. Is either a ReissueCertificateOrderRequest type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
renew
Renew an existing certificate order.
Renew an existing certificate order.
renew(resource_group_name: str, certificate_order_name: str, renew_certificate_order_request: _models.RenewCertificateOrderRequest, *, content_type: str = 'application/json', **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
renew_certificate_order_request
Required
|
Renew parameters. Is either a RenewCertificateOrderRequest type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
resend_email
Resend certificate email.
Resend certificate email.
resend_email(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
resend_request_emails
Verify domain ownership for this certificate order.
Verify domain ownership for this certificate order.
resend_request_emails(resource_group_name: str, certificate_order_name: str, name_identifier: _models.NameIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
name_identifier
Required
|
Email address. Is either a NameIdentifier type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
retrieve_certificate_actions
Retrieve the list of certificate actions.
Retrieve the list of certificate actions.
retrieve_certificate_actions(resource_group_name: str, name: str, **kwargs: Any) -> List[CertificateOrderAction]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the certificate order. Required. |
Returns
| Type | Description |
|---|---|
|
list of CertificateOrderAction or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
retrieve_certificate_email_history
Retrieve email history.
Retrieve email history.
retrieve_certificate_email_history(resource_group_name: str, name: str, **kwargs: Any) -> List[CertificateEmail]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
name
Required
|
Name of the certificate order. Required. |
Returns
| Type | Description |
|---|---|
|
list of CertificateEmail or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
retrieve_site_seal
Verify domain ownership for this certificate order.
Verify domain ownership for this certificate order.
retrieve_site_seal(resource_group_name: str, certificate_order_name: str, site_seal_request: _models.SiteSealRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SiteSealParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
site_seal_request
Required
|
Site seal request. Is either a SiteSealRequest type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
SiteSeal or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Create or update a certificate purchase order.
Create or update a certificate purchase order.
update(resource_group_name: str, certificate_order_name: str, certificate_distinguished_name: _models.AppServiceCertificateOrderPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AppServiceCertificateOrderParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
certificate_distinguished_name
Required
|
Distinguished name to use for the certificate order. Is either a AppServiceCertificateOrderPatchResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
AppServiceCertificateOrder or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update_certificate
Creates or updates a certificate and associates with key vault secret.
Creates or updates a certificate and associates with key vault secret.
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.AppServiceCertificateResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
|
name
Required
|
Name of the certificate. Required. |
|
key_vault_certificate
Required
|
Key vault certificate resource Id. Is either a AppServiceCertificatePatchResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
AppServiceCertificateResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
validate_purchase_information
Validate information for a certificate order.
Validate information for a certificate order.
validate_purchase_information(app_service_certificate_order: _models.AppServiceCertificateOrder, *, content_type: str = 'application/json', **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
app_service_certificate_order
Required
|
Information for a certificate order. Is either a AppServiceCertificateOrder type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
verify_domain_ownership
Verify domain ownership for this certificate order.
Verify domain ownership for this certificate order.
verify_domain_ownership(resource_group_name: str, certificate_order_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
certificate_order_name
Required
|
Name of the certificate order. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.web.v2019_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2019_08_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for