AppServiceCertificateOrdersOperations interface

Package:

@azure/arm-certificateregistration

Interface representing a AppServiceCertificateOrders operations.

Properties

createOrUpdate	Description for Create or update a certificate purchase order.
createOrUpdateCertificate	Description for Creates or updates a certificate and associates with key vault secret.
delete
deleteCertificate	Description for Delete the certificate associated with a certificate order.
get	Description for Get a certificate order.
getCertificate	Description for Get the certificate associated with a certificate order.
list	Description for List all certificate orders in a subscription.
listByResourceGroup	Description for Get certificate orders in a resource group.
listCertificates	Description for List all certificates associated with a certificate order.
reissue	Description for Reissue an existing certificate order.
renew	Description for Renew an existing certificate order.
resendEmail	Description for Resend certificate email.
resendRequestEmails	Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order
retrieveCertificateActions	Description for Retrieve the list of certificate actions.
retrieveCertificateEmailHistory	Description for Retrieve email history.
retrieveSiteSeal	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	Description for Create or update a certificate purchase order.
updateCertificate	Description for Creates or updates a certificate and associates with key vault secret.
validatePurchaseInformation	Description for Validate information for a certificate order.
verifyDomainOwnership	Description for Verify domain ownership for this certificate order.

Property Details

createOrUpdate

Description for Create or update a certificate purchase order.

createOrUpdate: (resourceGroupName: string, certificateOrderName: string, certificateDistinguishedName: AppServiceCertificateOrder, options?: AppServiceCertificateOrdersCreateOrUpdateOptionalParams) => PollerLike<OperationState<AppServiceCertificateOrder>, AppServiceCertificateOrder>

Property Value

(resourceGroupName: string, certificateOrderName: string, certificateDistinguishedName: AppServiceCertificateOrder, options?: AppServiceCertificateOrdersCreateOrUpdateOptionalParams) => PollerLike<OperationState<AppServiceCertificateOrder>, AppServiceCertificateOrder>

createOrUpdateCertificate

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

createOrUpdateCertificate: (resourceGroupName: string, certificateOrderName: string, name: string, keyVaultCertificate: AppServiceCertificateResource, options?: AppServiceCertificateOrdersCreateOrUpdateCertificateOptionalParams) => PollerLike<OperationState<AppServiceCertificateResource>, AppServiceCertificateResource>

Property Value

(resourceGroupName: string, certificateOrderName: string, name: string, keyVaultCertificate: AppServiceCertificateResource, options?: AppServiceCertificateOrdersCreateOrUpdateCertificateOptionalParams) => PollerLike<OperationState<AppServiceCertificateResource>, AppServiceCertificateResource>

delete

delete: (resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersDeleteOptionalParams) => Promise<void>

deleteCertificate

Description for Delete the certificate associated with a certificate order.

deleteCertificate: (resourceGroupName: string, certificateOrderName: string, name: string, options?: AppServiceCertificateOrdersDeleteCertificateOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, certificateOrderName: string, name: string, options?: AppServiceCertificateOrdersDeleteCertificateOptionalParams) => Promise<void>

get

Description for Get a certificate order.

get: (resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersGetOptionalParams) => Promise<AppServiceCertificateOrder>

Property Value

(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersGetOptionalParams) => Promise<AppServiceCertificateOrder>

getCertificate

Description for Get the certificate associated with a certificate order.

getCertificate: (resourceGroupName: string, certificateOrderName: string, name: string, options?: AppServiceCertificateOrdersGetCertificateOptionalParams) => Promise<AppServiceCertificateResource>

Property Value

(resourceGroupName: string, certificateOrderName: string, name: string, options?: AppServiceCertificateOrdersGetCertificateOptionalParams) => Promise<AppServiceCertificateResource>

list

Description for List all certificate orders in a subscription.

list: (options?: AppServiceCertificateOrdersListOptionalParams) => PagedAsyncIterableIterator<AppServiceCertificateOrder, AppServiceCertificateOrder[], PageSettings>

Property Value

(options?: AppServiceCertificateOrdersListOptionalParams) => PagedAsyncIterableIterator<AppServiceCertificateOrder, AppServiceCertificateOrder[], PageSettings>

listByResourceGroup

Description for Get certificate orders in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: AppServiceCertificateOrdersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<AppServiceCertificateOrder, AppServiceCertificateOrder[], PageSettings>

Property Value

(resourceGroupName: string, options?: AppServiceCertificateOrdersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<AppServiceCertificateOrder, AppServiceCertificateOrder[], PageSettings>

listCertificates

Description for List all certificates associated with a certificate order.

listCertificates: (resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersListCertificatesOptionalParams) => PagedAsyncIterableIterator<AppServiceCertificateResource, AppServiceCertificateResource[], PageSettings>

Property Value

(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersListCertificatesOptionalParams) => PagedAsyncIterableIterator<AppServiceCertificateResource, AppServiceCertificateResource[], PageSettings>

reissue

Description for Reissue an existing certificate order.

reissue: (resourceGroupName: string, certificateOrderName: string, reissueCertificateOrderRequest: ReissueCertificateOrderRequest, options?: AppServiceCertificateOrdersReissueOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, certificateOrderName: string, reissueCertificateOrderRequest: ReissueCertificateOrderRequest, options?: AppServiceCertificateOrdersReissueOptionalParams) => Promise<void>

renew

Description for Renew an existing certificate order.

renew: (resourceGroupName: string, certificateOrderName: string, renewCertificateOrderRequest: RenewCertificateOrderRequest, options?: AppServiceCertificateOrdersRenewOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, certificateOrderName: string, renewCertificateOrderRequest: RenewCertificateOrderRequest, options?: AppServiceCertificateOrdersRenewOptionalParams) => Promise<void>

resendEmail

Description for Resend certificate email.

resendEmail: (resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersResendEmailOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersResendEmailOptionalParams) => Promise<void>

resendRequestEmails

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

resendRequestEmails: (resourceGroupName: string, certificateOrderName: string, nameIdentifier: NameIdentifier, options?: AppServiceCertificateOrdersResendRequestEmailsOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, certificateOrderName: string, nameIdentifier: NameIdentifier, options?: AppServiceCertificateOrdersResendRequestEmailsOptionalParams) => Promise<void>

retrieveCertificateActions

Description for Retrieve the list of certificate actions.

retrieveCertificateActions: (resourceGroupName: string, name: string, options?: AppServiceCertificateOrdersRetrieveCertificateActionsOptionalParams) => Promise<CertificateOrderAction[]>

Property Value

(resourceGroupName: string, name: string, options?: AppServiceCertificateOrdersRetrieveCertificateActionsOptionalParams) => Promise<CertificateOrderAction[]>

retrieveCertificateEmailHistory

Description for Retrieve email history.

retrieveCertificateEmailHistory: (resourceGroupName: string, name: string, options?: AppServiceCertificateOrdersRetrieveCertificateEmailHistoryOptionalParams) => Promise<CertificateEmail[]>

Property Value

(resourceGroupName: string, name: string, options?: AppServiceCertificateOrdersRetrieveCertificateEmailHistoryOptionalParams) => Promise<CertificateEmail[]>

retrieveSiteSeal

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.

retrieveSiteSeal: (resourceGroupName: string, certificateOrderName: string, siteSealRequest: SiteSealRequest, options?: AppServiceCertificateOrdersRetrieveSiteSealOptionalParams) => Promise<SiteSeal>

Property Value

(resourceGroupName: string, certificateOrderName: string, siteSealRequest: SiteSealRequest, options?: AppServiceCertificateOrdersRetrieveSiteSealOptionalParams) => Promise<SiteSeal>

update

Description for Create or update a certificate purchase order.

update: (resourceGroupName: string, certificateOrderName: string, certificateDistinguishedName: AppServiceCertificateOrderPatchResource, options?: AppServiceCertificateOrdersUpdateOptionalParams) => Promise<AppServiceCertificateOrder>

Property Value

(resourceGroupName: string, certificateOrderName: string, certificateDistinguishedName: AppServiceCertificateOrderPatchResource, options?: AppServiceCertificateOrdersUpdateOptionalParams) => Promise<AppServiceCertificateOrder>

updateCertificate

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

updateCertificate: (resourceGroupName: string, certificateOrderName: string, name: string, keyVaultCertificate: AppServiceCertificatePatchResource, options?: AppServiceCertificateOrdersUpdateCertificateOptionalParams) => Promise<AppServiceCertificateResource>

Property Value

(resourceGroupName: string, certificateOrderName: string, name: string, keyVaultCertificate: AppServiceCertificatePatchResource, options?: AppServiceCertificateOrdersUpdateCertificateOptionalParams) => Promise<AppServiceCertificateResource>

validatePurchaseInformation

Description for Validate information for a certificate order.

validatePurchaseInformation: (appServiceCertificateOrder: AppServiceCertificateOrder, options?: AppServiceCertificateOrdersValidatePurchaseInformationOptionalParams) => Promise<void>

Property Value

(appServiceCertificateOrder: AppServiceCertificateOrder, options?: AppServiceCertificateOrdersValidatePurchaseInformationOptionalParams) => Promise<void>

verifyDomainOwnership

Description for Verify domain ownership for this certificate order.

verifyDomainOwnership: (resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersVerifyDomainOwnershipOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, certificateOrderName: string, options?: AppServiceCertificateOrdersVerifyDomainOwnershipOptionalParams) => Promise<void>