AppServiceCertificateOrders interface
Interface representing a AppServiceCertificateOrders.
Methods
Method Details
beginCreateOrUpdate(string, string, AppServiceCertificateOrder, AppServiceCertificateOrdersCreateOrUpdateOptionalParams)
Description for Create or update a certificate purchase order.
function beginCreateOrUpdate(resourceGroupName: string, certificateOrderName: string, certificateDistinguishedName: AppServiceCertificateOrder, options?: AppServiceCertificateOrdersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AppServiceCertificateOrder>, AppServiceCertificateOrder>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- certificateDistinguishedName
- AppServiceCertificateOrder
Distinguished name to use for the certificate order.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AppServiceCertificateOrder>, AppServiceCertificateOrder>>
beginCreateOrUpdateAndWait(string, string, AppServiceCertificateOrder, AppServiceCertificateOrdersCreateOrUpdateOptionalParams)
Description for Create or update a certificate purchase order.
function beginCreateOrUpdateAndWait(resourceGroupName: string, certificateOrderName: string, certificateDistinguishedName: AppServiceCertificateOrder, options?: AppServiceCertificateOrdersCreateOrUpdateOptionalParams): Promise<AppServiceCertificateOrder>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- certificateDistinguishedName
- AppServiceCertificateOrder
Distinguished name to use for the certificate order.
The options parameters.
Returns
Promise<AppServiceCertificateOrder>
beginCreateOrUpdateCertificate(string, string, string, AppServiceCertificateResource, AppServiceCertificateOrdersCreateOrUpdateCertificateOptionalParams)
Description for Creates or updates a certificate and associates with key vault secret.
function beginCreateOrUpdateCertificate(resourceGroupName: string, certificateOrderName: string, name: string, keyVaultCertificate: AppServiceCertificateResource, options?: AppServiceCertificateOrdersCreateOrUpdateCertificateOptionalParams): Promise<SimplePollerLike<OperationState<AppServiceCertificateResource>, AppServiceCertificateResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- name
-
string
Name of the certificate.
- keyVaultCertificate
- AppServiceCertificateResource
Key vault certificate resource Id.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AppServiceCertificateResource>, AppServiceCertificateResource>>
beginCreateOrUpdateCertificateAndWait(string, string, string, AppServiceCertificateResource, AppServiceCertificateOrdersCreateOrUpdateCertificateOptionalParams)
Description for Creates or updates a certificate and associates with key vault secret.
function beginCreateOrUpdateCertificateAndWait(resourceGroupName: string, certificateOrderName: string, name: string, keyVaultCertificate: AppServiceCertificateResource, options?: AppServiceCertificateOrdersCreateOrUpdateCertificateOptionalParams): Promise<AppServiceCertificateResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- name
-
string
Name of the certificate.
- keyVaultCertificate
- AppServiceCertificateResource
Key vault certificate resource Id.
The options parameters.
Returns
Promise<AppServiceCertificateResource>
delete(string, string, AppServiceCertificateOrdersDeleteOptionalParams)
Description for Delete an existing certificate order.
function delete(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
The options parameters.
Returns
Promise<void>
deleteCertificate(string, string, string, AppServiceCertificateOrdersDeleteCertificateOptionalParams)
Description for Delete the certificate associated with a certificate order.
function deleteCertificate(resourceGroupName: string, certificateOrderName: string, name: string, options?: AppServiceCertificateOrdersDeleteCertificateOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- name
-
string
Name of the certificate.
The options parameters.
Returns
Promise<void>
get(string, string, AppServiceCertificateOrdersGetOptionalParams)
Description for Get a certificate order.
function get(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersGetOptionalParams): Promise<AppServiceCertificateOrder>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order..
The options parameters.
Returns
Promise<AppServiceCertificateOrder>
getCertificate(string, string, string, AppServiceCertificateOrdersGetCertificateOptionalParams)
Description for Get the certificate associated with a certificate order.
function getCertificate(resourceGroupName: string, certificateOrderName: string, name: string, options?: AppServiceCertificateOrdersGetCertificateOptionalParams): Promise<AppServiceCertificateResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- name
-
string
Name of the certificate.
The options parameters.
Returns
Promise<AppServiceCertificateResource>
list(AppServiceCertificateOrdersListOptionalParams)
Description for List all certificate orders in a subscription.
function list(options?: AppServiceCertificateOrdersListOptionalParams): PagedAsyncIterableIterator<AppServiceCertificateOrder, AppServiceCertificateOrder[], PageSettings>Parameters
The options parameters.
Returns
listByResourceGroup(string, AppServiceCertificateOrdersListByResourceGroupOptionalParams)
Description for Get certificate orders in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: AppServiceCertificateOrdersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AppServiceCertificateOrder, AppServiceCertificateOrder[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
The options parameters.
Returns
listCertificates(string, string, AppServiceCertificateOrdersListCertificatesOptionalParams)
Description for List all certificates associated with a certificate order.
function listCertificates(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersListCertificatesOptionalParams): PagedAsyncIterableIterator<AppServiceCertificateResource, AppServiceCertificateResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
The options parameters.
Returns
reissue(string, string, ReissueCertificateOrderRequest, AppServiceCertificateOrdersReissueOptionalParams)
Description for Reissue an existing certificate order.
function reissue(resourceGroupName: string, certificateOrderName: string, reissueCertificateOrderRequest: ReissueCertificateOrderRequest, options?: AppServiceCertificateOrdersReissueOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- reissueCertificateOrderRequest
- ReissueCertificateOrderRequest
Parameters for the reissue.
The options parameters.
Returns
Promise<void>
renew(string, string, RenewCertificateOrderRequest, AppServiceCertificateOrdersRenewOptionalParams)
Description for Renew an existing certificate order.
function renew(resourceGroupName: string, certificateOrderName: string, renewCertificateOrderRequest: RenewCertificateOrderRequest, options?: AppServiceCertificateOrdersRenewOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- renewCertificateOrderRequest
- RenewCertificateOrderRequest
Renew parameters
The options parameters.
Returns
Promise<void>
resendEmail(string, string, AppServiceCertificateOrdersResendEmailOptionalParams)
Description for Resend certificate email.
function resendEmail(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersResendEmailOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
The options parameters.
Returns
Promise<void>
resendRequestEmails(string, string, NameIdentifier, AppServiceCertificateOrdersResendRequestEmailsOptionalParams)
Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order
function resendRequestEmails(resourceGroupName: string, certificateOrderName: string, nameIdentifier: NameIdentifier, options?: AppServiceCertificateOrdersResendRequestEmailsOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- nameIdentifier
- NameIdentifier
Email address
The options parameters.
Returns
Promise<void>
retrieveCertificateActions(string, string, AppServiceCertificateOrdersRetrieveCertificateActionsOptionalParams)
Description for Retrieve the list of certificate actions.
function retrieveCertificateActions(resourceGroupName: string, name: string, options?: AppServiceCertificateOrdersRetrieveCertificateActionsOptionalParams): Promise<AppServiceCertificateOrdersRetrieveCertificateActionsResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the certificate order.
The options parameters.
Returns
retrieveCertificateEmailHistory(string, string, AppServiceCertificateOrdersRetrieveCertificateEmailHistoryOptionalParams)
Description for Retrieve email history.
function retrieveCertificateEmailHistory(resourceGroupName: string, name: string, options?: AppServiceCertificateOrdersRetrieveCertificateEmailHistoryOptionalParams): Promise<AppServiceCertificateOrdersRetrieveCertificateEmailHistoryResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the certificate order.
The options parameters.
Returns
retrieveSiteSeal(string, string, SiteSealRequest, AppServiceCertificateOrdersRetrieveSiteSealOptionalParams)
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.
function retrieveSiteSeal(resourceGroupName: string, certificateOrderName: string, siteSealRequest: SiteSealRequest, options?: AppServiceCertificateOrdersRetrieveSiteSealOptionalParams): Promise<SiteSeal>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- siteSealRequest
- SiteSealRequest
Site seal request.
The options parameters.
Returns
Promise<SiteSeal>
update(string, string, AppServiceCertificateOrderPatchResource, AppServiceCertificateOrdersUpdateOptionalParams)
Description for Create or update a certificate purchase order.
function update(resourceGroupName: string, certificateOrderName: string, certificateDistinguishedName: AppServiceCertificateOrderPatchResource, options?: AppServiceCertificateOrdersUpdateOptionalParams): Promise<AppServiceCertificateOrder>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- certificateDistinguishedName
- AppServiceCertificateOrderPatchResource
Distinguished name to use for the certificate order.
The options parameters.
Returns
Promise<AppServiceCertificateOrder>
updateCertificate(string, string, string, AppServiceCertificatePatchResource, AppServiceCertificateOrdersUpdateCertificateOptionalParams)
Description for Creates or updates a certificate and associates with key vault secret.
function updateCertificate(resourceGroupName: string, certificateOrderName: string, name: string, keyVaultCertificate: AppServiceCertificatePatchResource, options?: AppServiceCertificateOrdersUpdateCertificateOptionalParams): Promise<AppServiceCertificateResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
- name
-
string
Name of the certificate.
- keyVaultCertificate
- AppServiceCertificatePatchResource
Key vault certificate resource Id.
The options parameters.
Returns
Promise<AppServiceCertificateResource>
validatePurchaseInformation(AppServiceCertificateOrder, AppServiceCertificateOrdersValidatePurchaseInformationOptionalParams)
Description for Validate information for a certificate order.
function validatePurchaseInformation(appServiceCertificateOrder: AppServiceCertificateOrder, options?: AppServiceCertificateOrdersValidatePurchaseInformationOptionalParams): Promise<void>Parameters
- appServiceCertificateOrder
- AppServiceCertificateOrder
Information for a certificate order.
The options parameters.
Returns
Promise<void>
verifyDomainOwnership(string, string, AppServiceCertificateOrdersVerifyDomainOwnershipOptionalParams)
Description for Verify domain ownership for this certificate order.
function verifyDomainOwnership(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersVerifyDomainOwnershipOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- certificateOrderName
-
string
Name of the certificate order.
The options parameters.
Returns
Promise<void>