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

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	AppServiceCertificateOrder resource specific properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	AppServiceCertificateOrder resource specific properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	AppServiceCertificateOrder resource specific properties
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
certificateOrderName	string	Name of the certificate order.
name	string	Name of the certificate order.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

SELECT examples

get

Description for Get a certificate order.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.app_service.certificate_orders
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND certificateOrderName = '{{ certificateOrderName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Description for Get certificate orders in a resource group.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.app_service.certificate_orders
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Description for List all certificate orders in a subscription.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.app_service.certificate_orders
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Create or update a certificate purchase order.

INSERT INTO azure.app_service.certificate_orders (
data__properties,
resourceGroupName,
certificateOrderName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ certificateOrderName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: certificate_orders
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the certificate_orders resource.
    - name: certificateOrderName
      value: string
      description: Required parameter for the certificate_orders resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the certificate_orders resource.
    - name: properties
      value: object
      description: |
        AppServiceCertificateOrder resource specific properties

UPDATE examples

update

Description for Create or update a certificate purchase order.

UPDATE azure.app_service.certificate_orders
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND certificateOrderName = '{{ certificateOrderName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Description for Delete an existing certificate order.

DELETE FROM azure.app_service.certificate_orders
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND certificateOrderName = '{{ certificateOrderName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

validate_purchase_information

Description for Validate information for a certificate order.

EXEC azure.app_service.certificate_orders.validate_purchase_information 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

reissue

Description for Reissue an existing certificate order.

EXEC azure.app_service.certificate_orders.reissue 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@certificateOrderName='{{ certificateOrderName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

renew

Description for Renew an existing certificate order.

EXEC azure.app_service.certificate_orders.renew 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@certificateOrderName='{{ certificateOrderName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

resend_email

Description for Resend certificate email.

EXEC azure.app_service.certificate_orders.resend_email 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@certificateOrderName='{{ certificateOrderName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

resend_request_emails

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

EXEC azure.app_service.certificate_orders.resend_request_emails 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@certificateOrderName='{{ certificateOrderName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;

retrieve_site_seal

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.

EXEC azure.app_service.certificate_orders.retrieve_site_seal 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@certificateOrderName='{{ certificateOrderName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"lightTheme": {{ lightTheme }}, 
"locale": "{{ locale }}"
}'
;

verify_domain_ownership

Description for Verify domain ownership for this certificate order.

EXEC azure.app_service.certificate_orders.verify_domain_ownership 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@certificateOrderName='{{ certificateOrderName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

retrieve_certificate_actions

Description for Retrieve the list of certificate actions.

EXEC azure.app_service.certificate_orders.retrieve_certificate_actions 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

retrieve_certificate_email_history

Description for Retrieve email history.

EXEC azure.app_service.certificate_orders.retrieve_certificate_email_history 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;