azure.mgmt.web.v2015_08_01.operations module

class azure.mgmt.web.v2015_08_01.operations.AppServiceCertificateOrdersOperations(client, config, serializer, deserializer)[source]

Bases: object

AppServiceCertificateOrdersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2015-08-01”.

create_or_update(resource_group_name, certificate_order_name, certificate_distinguished_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a certificate purchase order.

Create or update a certificate purchase order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • certificate_distinguished_name (AppServiceCertificateOrder) – Distinguished name to use for the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AppServiceCertificateOrder or ClientRawResponse<AppServiceCertificateOrder> if raw==True

Return type

AzureOperationPoller[AppServiceCertificateOrder] or AzureOperationPoller[ClientRawResponse[AppServiceCertificateOrder]]

Raises

CloudError

create_or_update_certificate(resource_group_name, certificate_order_name, name, key_vault_certificate, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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

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

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • name (str) – Name of the certificate.

  • key_vault_certificate (AppServiceCertificateResource) – Key vault certificate resource Id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns AppServiceCertificateResource or ClientRawResponse<AppServiceCertificateResource> if raw==True

Return type

AzureOperationPoller[AppServiceCertificateResource] or AzureOperationPoller[ClientRawResponse[AppServiceCertificateResource]]

Raises

CloudError

delete(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Delete an existing certificate order.

Delete an existing certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_certificate(resource_group_name, certificate_order_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete the certificate associated with a certificate order.

Delete the certificate associated with a certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • name (str) – Name of the certificate.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Get a certificate order.

Get a certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order..

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

AppServiceCertificateOrder or ClientRawResponse if raw=true

Return type

AppServiceCertificateOrder or ClientRawResponse

Raises

CloudError

get_certificate(resource_group_name, certificate_order_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get the certificate associated with a certificate order.

Get the certificate associated with a certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • name (str) – Name of the certificate.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

AppServiceCertificateResource or ClientRawResponse if raw=true

Return type

AppServiceCertificateResource or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

List all certificate orders in a subscription.

List all certificate orders in a subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServiceCertificateOrder

Return type

AppServiceCertificateOrderPaged[AppServiceCertificateOrder]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get certificate orders in a resource group.

Get certificate orders in a resource group.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServiceCertificateOrder

Return type

AppServiceCertificateOrderPaged[AppServiceCertificateOrder]

Raises

CloudError

list_certificates(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

List all certificates associated with a certificate order.

List all certificates associated with a certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of AppServiceCertificateResource

Return type

AppServiceCertificateResourcePaged[AppServiceCertificateResource]

Raises

CloudError

reissue(resource_group_name, certificate_order_name, reissue_certificate_order_request, custom_headers=None, raw=False, **operation_config)[source]

Reissue an existing certificate order.

Reissue an existing certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • reissue_certificate_order_request (ReissueCertificateOrderRequest) – Parameters for the reissue.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

renew(resource_group_name, certificate_order_name, renew_certificate_order_request, custom_headers=None, raw=False, **operation_config)[source]

Renew an existing certificate order.

Renew an existing certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • renew_certificate_order_request (RenewCertificateOrderRequest) – Renew parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

resend_email(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Resend certificate email.

Resend certificate email.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

resend_request_emails(resource_group_name, certificate_order_name, name=None, custom_headers=None, raw=False, **operation_config)[source]

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • name (str) – Name of the object.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

retrieve_certificate_actions(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve the list of certificate actions.

Retrieve the list of certificate actions.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • name (str) – Name of the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[CertificateOrderAction] or ClientRawResponse

Raises

CloudError

retrieve_certificate_email_history(resource_group_name, name, custom_headers=None, raw=False, **operation_config)[source]

Retrieve email history.

Retrieve email history.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • name (str) – Name of the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[CertificateEmail] or ClientRawResponse

Raises

CloudError

retrieve_site_seal(resource_group_name, certificate_order_name, light_theme=None, locale=None, custom_headers=None, raw=False, **operation_config)[source]

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • light_theme (bool) – If <code>true</code> use the light color theme for site seal; otherwise, use the default color theme.

  • locale (str) – Locale of site seal.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

SiteSeal or ClientRawResponse if raw=true

Return type

SiteSeal or ClientRawResponse

Raises

CloudError

update(resource_group_name, certificate_order_name, certificate_distinguished_name, custom_headers=None, raw=False, **operation_config)[source]

Create or update a certificate purchase order.

Create or update a certificate purchase order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • certificate_distinguished_name (AppServiceCertificateOrderPatchResource) – Distinguished name to use for the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

AppServiceCertificateOrder or ClientRawResponse if raw=true

Return type

AppServiceCertificateOrder or ClientRawResponse

Raises

CloudError

update_certificate(resource_group_name, certificate_order_name, name, key_vault_certificate, custom_headers=None, raw=False, **operation_config)[source]

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

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

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • name (str) – Name of the certificate.

  • key_vault_certificate (AppServiceCertificatePatchResource) – Key vault certificate resource Id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

AppServiceCertificateResource or ClientRawResponse if raw=true

Return type

AppServiceCertificateResource or ClientRawResponse

Raises

CloudError

validate_purchase_information(app_service_certificate_order, custom_headers=None, raw=False, **operation_config)[source]

Validate information for a certificate order.

Validate information for a certificate order.

Parameters

  • app_service_certificate_order (AppServiceCertificateOrder) – Information for a certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

verify_domain_ownership(resource_group_name, certificate_order_name, custom_headers=None, raw=False, **operation_config)[source]

Verify domain ownership for this certificate order.

Verify domain ownership for this certificate order.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • certificate_order_name (str) – Name of the certificate order.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.web.v2015_08_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2015_08_01/models/__init__.py'>
class azure.mgmt.web.v2015_08_01.operations.CertificateRegistrationProviderOperations(client, config, serializer, deserializer)[source]

Bases: object

CertificateRegistrationProviderOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2015-08-01”.

list_operations(custom_headers=None, raw=False, **operation_config)[source]

Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.

Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of CsmOperationDescription

Return type

CsmOperationDescriptionPaged[CsmOperationDescription]

Raises

CloudError

models = <module 'azure.mgmt.web.v2015_08_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2015_08_01/models/__init__.py'>