certificates

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

Overview

Name	certificates
Type	Resource
Id	azure_extras.app_platform.certificates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
activateDate	string	The activate date of certificate.
dnsNames	array	The domain list of certificate.
expirationDate	string	The expiration date of certificate.
issuedDate	string	The issue date of certificate.
issuer	string	The issuer of certificate.
provisioningState	string	Provisioning state of the Certificate. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
subjectName	string	The subject name of certificate.
systemData	object	Metadata pertaining to creation and last modification of the resource.
thumbprint	string	The thumbprint of certificate.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
activateDate	string	The activate date of certificate.
dnsNames	array	The domain list of certificate.
expirationDate	string	The expiration date of certificate.
issuedDate	string	The issue date of certificate.
issuer	string	The issuer of certificate.
provisioningState	string	Provisioning state of the Certificate. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
subjectName	string	The subject name of certificate.
systemData	object	Metadata pertaining to creation and last modification of the resource.
thumbprint	string	The thumbprint of certificate.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, certificate_name, subscription_id		Get the certificate resource.
list	select	resource_group_name, service_name, subscription_id		List all the certificates of one user.
create_or_update	insert	resource_group_name, service_name, certificate_name, subscription_id		Create or update certificate resource.
create_or_update	replace	resource_group_name, service_name, certificate_name, subscription_id		Create or update certificate resource.
delete	delete	resource_group_name, service_name, certificate_name, subscription_id		Delete the certificate resource.

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
certificate_name	string	The name of the certificate resource. Required.
resource_group_name	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the certificate resource.

SELECT
id,
name,
activateDate,
dnsNames,
expirationDate,
issuedDate,
issuer,
provisioningState,
subjectName,
systemData,
thumbprint,
type
FROM azure_extras.app_platform.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND certificate_name = '{{ certificate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all the certificates of one user.

SELECT
id,
name,
activateDate,
dnsNames,
expirationDate,
issuedDate,
issuer,
provisioningState,
subjectName,
systemData,
thumbprint,
type
FROM azure_extras.app_platform.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update certificate resource.

INSERT INTO azure_extras.app_platform.certificates (
properties,
resource_group_name,
service_name,
certificate_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ certificate_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: certificates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the certificates resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the certificates resource.
  - name: certificate_name
    value: "{{ certificate_name }}"
    description: Required parameter for the certificates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the certificates resource.
  - name: properties
    description: |
      Properties of the certificate resource payload.
    value:
      type: "{{ type }}"
      thumbprint: "{{ thumbprint }}"
      issuer: "{{ issuer }}"
      issuedDate: "{{ issuedDate }}"
      expirationDate: "{{ expirationDate }}"
      activateDate: "{{ activateDate }}"
      subjectName: "{{ subjectName }}"
      dnsNames:
        - "{{ dnsNames }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create or update certificate resource.

REPLACE azure_extras.app_platform.certificates
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the certificate resource.

DELETE FROM azure_extras.app_platform.certificates
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;