certificate_orders

Creates, updates, deletes, gets or lists a certificate_orders resource.

Overview

Name	certificate_orders
Type	Resource
Id	azure.app_service.certificate_orders

Fields

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
location	string	Resource Location.
properties	object	AppServiceCertificateOrder resource specific properties
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	certificateOrderName, resourceGroupName, subscriptionId	Description for Get a certificate order.
list	SELECT	subscriptionId	Description for List all certificate orders in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Description for Get certificate orders in a resource group.
create_or_update	INSERT	certificateOrderName, resourceGroupName, subscriptionId	Description for Create or update a certificate purchase order.
delete	DELETE	certificateOrderName, resourceGroupName, subscriptionId	Description for Delete an existing certificate order.
update	UPDATE	certificateOrderName, resourceGroupName, subscriptionId	Description for Create or update a certificate purchase order.
reissue	EXEC	certificateOrderName, resourceGroupName, subscriptionId	Description for Reissue an existing certificate order.
renew	EXEC	certificateOrderName, resourceGroupName, subscriptionId	Description for Renew an existing certificate order.
resend_email	EXEC	certificateOrderName, resourceGroupName, subscriptionId	Description for Resend certificate email.
resend_request_emails	EXEC	certificateOrderName, resourceGroupName, subscriptionId	Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order
retrieve_certificate_actions	EXEC	name, resourceGroupName, subscriptionId	Description for Retrieve the list of certificate actions.
retrieve_certificate_email_history	EXEC	name, resourceGroupName, subscriptionId	Description for Retrieve email history.
retrieve_site_seal	EXEC	certificateOrderName, resourceGroupName, subscriptionId	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.
validate_purchase_information	EXEC	subscriptionId	Description for Validate information for a certificate order.
verify_domain_ownership	EXEC	certificateOrderName, resourceGroupName, subscriptionId	Description for Verify domain ownership for this certificate order.

SELECT examples

Description for List all certificate orders in a subscription.

SELECT
id,
name,
kind,
location,
properties,
tags,
type
FROM azure.app_service.certificate_orders
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new certificate_orders resource.

All Properties

/*+ create */
INSERT INTO azure.app_service.certificate_orders (
certificateOrderName,
resourceGroupName,
subscriptionId,
kind,
location,
tags,
properties
)
SELECT 
'{{ certificateOrderName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ kind }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: kind
      value: string
    - name: location
      value: string
    - name: type
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: certificates
          value: object
        - name: distinguishedName
          value: string
        - name: domainVerificationToken
          value: string
        - name: validityInYears
          value: integer
        - name: keySize
          value: integer
        - name: productType
          value: string
        - name: autoRenew
          value: boolean
        - name: provisioningState
          value: string
        - name: status
          value: string
        - name: signedCertificate
          value:
            - name: version
              value: integer
            - name: serialNumber
              value: string
            - name: thumbprint
              value: string
            - name: subject
              value: string
            - name: notBefore
              value: string
            - name: notAfter
              value: string
            - name: signatureAlgorithm
              value: string
            - name: issuer
              value: string
            - name: rawData
              value: string
        - name: csr
          value: string
        - name: serialNumber
          value: string
        - name: lastCertificateIssuanceTime
          value: string
        - name: expirationTime
          value: string
        - name: isPrivateKeyExternal
          value: boolean
        - name: appServiceCertificateNotRenewableReasons
          value:
            - string
        - name: nextAutoRenewalTimeStamp
          value: string
        - name: contact
          value:
            - name: email
              value: string
            - name: nameFirst
              value: string
            - name: nameLast
              value: string
            - name: phone
              value: string

UPDATE example

Updates a certificate_orders resource.

/*+ update */
UPDATE azure.app_service.certificate_orders
SET 
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
certificateOrderName = '{{ certificateOrderName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified certificate_orders resource.

/*+ delete */
DELETE FROM azure.app_service.certificate_orders
WHERE certificateOrderName = '{{ certificateOrderName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';