Skip to main content

app_service_certificate_orders

Creates, updates, deletes, gets or lists an app_service_certificate_orders resource.

Overview

Nameapp_service_certificate_orders
TypeResource
Idazure.certificate_registration.app_service_certificate_orders

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
keyVaultIdstringKey Vault resource Id.
keyVaultSecretNamestringKey Vault secret name.
kindstringKind of resource.
locationstringThe geo-location where the resource lives. Required.
provisioningStatestringStatus of the Key Vault secret. Known values are: "Initialized", "WaitingOnCertificateOrder", "Succeeded", "CertificateOrderFailed", "OperationNotPermittedOnKeyVault", "AzureServiceUnauthorizedToAccessKeyVault", "KeyVaultDoesNotExist", "KeyVaultSecretDoesNotExist", "UnknownError", "ExternalPrivateKey", and "Unknown". (Initialized, WaitingOnCertificateOrder, Succeeded, CertificateOrderFailed, OperationNotPermittedOnKeyVault, AzureServiceUnauthorizedToAccessKeyVault, KeyVaultDoesNotExist, KeyVaultSecretDoesNotExist, UnknownError, ExternalPrivateKey, Unknown)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_certificateselectresource_group_name, certificate_order_name, name, subscription_idGet the certificate associated with a certificate order. Description for Get the certificate associated with a certificate order.
getselectresource_group_name, certificate_order_name, subscription_idGet a certificate order. Description for Get a certificate order.
retrieve_certificate_actionsselectresource_group_name, name, subscription_idRetrieve the list of certificate actions. Description for Retrieve the list of certificate actions.
list_by_resource_groupselectresource_group_name, subscription_idGet certificate orders in a resource group. Description for Get certificate orders in a resource group.
listselectsubscription_idList all certificate orders in a subscription. Description for List all certificate orders in a subscription.
create_or_updateinsertresource_group_name, certificate_order_name, subscription_id, locationCreate or update a certificate purchase order. Description for Create or update a certificate purchase order.
updateupdateresource_group_name, certificate_order_name, subscription_idCreate or update a certificate purchase order. Description for Create or update a certificate purchase order.
create_or_updatereplaceresource_group_name, certificate_order_name, subscription_id, locationCreate or update a certificate purchase order. Description for Create or update a certificate purchase order.
deletedeleteresource_group_name, certificate_order_name, subscription_idDelete an existing certificate order. Description for Delete an existing certificate order.
list_certificatesexecresource_group_name, certificate_order_name, subscription_idList all certificates associated with a certificate order. Description for List all certificates associated with a certificate order.
create_or_update_certificateexecresource_group_name, certificate_order_name, name, subscription_id, locationCreates or updates a certificate and associates with key vault secret. Description for Creates or updates a certificate and associates with key vault secret.
update_certificateexecresource_group_name, certificate_order_name, name, subscription_idCreates or updates a certificate and associates with key vault secret. Description for Creates or updates a certificate and associates with key vault secret.
delete_certificateexecresource_group_name, certificate_order_name, name, subscription_idDelete the certificate associated with a certificate order. Description for Delete the certificate associated with a certificate order.
reissueexecresource_group_name, certificate_order_name, subscription_idReissue an existing certificate order. Description for Reissue an existing certificate order.
renewexecresource_group_name, certificate_order_name, subscription_idRenew an existing certificate order. Description for Renew an existing certificate order.
resend_emailexecresource_group_name, certificate_order_name, subscription_idResend certificate email. Description for Resend certificate email.
resend_request_emailsexecresource_group_name, certificate_order_name, subscription_idResend domain verification email to customer for this certificate order. Resend domain verification ownership email containing steps on how to verify a domain for a given certificate order.
retrieve_site_sealexecresource_group_name, certificate_order_name, subscription_idThis method is used to obtain the site seal information for an issued certificate. 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_ownershipexecresource_group_name, certificate_order_name, subscription_idVerify domain ownership for this certificate order. Description for Verify domain ownership for this certificate order.
retrieve_certificate_email_historyexecresource_group_name, name, subscription_idRetrieve email history. Description for Retrieve email history.
validate_purchase_informationexecsubscription_id, locationValidate information for a certificate order. Description for Validate information for a certificate order.

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.

NameDatatypeDescription
certificate_order_namestringName of the certificate order.. Required.
namestringName of the certificate order.. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples

Get the certificate associated with a certificate order. Description for Get the certificate associated with a certificate order.

SELECT
id,
name,
keyVaultId,
keyVaultSecretName,
kind,
location,
provisioningState,
systemData,
tags,
type
FROM azure.certificate_registration.app_service_certificate_orders
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND certificate_order_name = '{{ certificate_order_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

Create or update a certificate purchase order. Description for Create or update a certificate purchase order.

INSERT INTO azure.certificate_registration.app_service_certificate_orders (
tags,
location,
properties,
kind,
resource_group_name,
certificate_order_name,
subscription_id
)
SELECT
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ certificate_order_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type
;

UPDATE examples

Create or update a certificate purchase order. Description for Create or update a certificate purchase order.

UPDATE azure.certificate_registration.app_service_certificate_orders
SET
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND certificate_order_name = '{{ certificate_order_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

Create or update a certificate purchase order. Description for Create or update a certificate purchase order.

REPLACE azure.certificate_registration.app_service_certificate_orders
SET
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
kind = '{{ kind }}'
WHERE
resource_group_name = '{{ resource_group_name }}' --required
AND certificate_order_name = '{{ certificate_order_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

Delete an existing certificate order. Description for Delete an existing certificate order.

DELETE FROM azure.certificate_registration.app_service_certificate_orders
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND certificate_order_name = '{{ certificate_order_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

List all certificates associated with a certificate order. Description for List all certificates associated with a certificate order.

EXEC azure.certificate_registration.app_service_certificate_orders.list_certificates 
@resource_group_name='{{ resource_group_name }}' --required,
@certificate_order_name='{{ certificate_order_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;