certificate

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

Overview

Name	certificate
Type	Resource
Id	azure.automation.certificate

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Gets the creation time.
description	string	Gets or sets the description.
expiryTime	string (date-time)	Gets the expiry time of the certificate.
isExportable	boolean	Gets the is exportable flag of the certificate.
lastModifiedTime	string (date-time)	Gets the last modified time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Gets the thumbprint of the certificate.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_automation_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Gets the creation time.
description	string	Gets or sets the description.
expiryTime	string (date-time)	Gets the expiry time of the certificate.
isExportable	boolean	Gets the is exportable flag of the certificate.
lastModifiedTime	string (date-time)	Gets the last modified time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	Gets the thumbprint of the certificate.
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	resource_group_name, automation_account_name, certificate_name, subscription_id		Retrieve the certificate identified by certificate name.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id		Retrieve a list of certificates.
create_or_update	insert	resource_group_name, automation_account_name, certificate_name, subscription_id, name, properties		Create a certificate.
update	update	resource_group_name, automation_account_name, certificate_name, subscription_id		Update a certificate.
create_or_update	replace	resource_group_name, automation_account_name, certificate_name, subscription_id, name, properties		Create a certificate.
delete	delete	resource_group_name, automation_account_name, certificate_name, subscription_id		Delete the certificate.

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
automation_account_name	string	The name of the automation account. Required.
certificate_name	string	The name of certificate. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieve the certificate identified by certificate name.

SELECT
id,
name,
creationTime,
description,
expiryTime,
isExportable,
lastModifiedTime,
systemData,
thumbprint,
type
FROM azure.automation.certificate
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND certificate_name = '{{ certificate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of certificates.

SELECT
id,
name,
creationTime,
description,
expiryTime,
isExportable,
lastModifiedTime,
systemData,
thumbprint,
type
FROM azure.automation.certificate
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a certificate.

INSERT INTO azure.automation.certificate (
name,
properties,
resource_group_name,
automation_account_name,
certificate_name,
subscription_id
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ certificate_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: certificate
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the certificate resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the certificate resource.
  - name: certificate_name
    value: "{{ certificate_name }}"
    description: Required parameter for the certificate resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the certificate resource.
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets the name of the certificate. Required.
  - name: properties
    description: |
      Gets or sets the properties of the certificate. Required.
    value:
      base64Value: "{{ base64Value }}"
      description: "{{ description }}"
      thumbprint: "{{ thumbprint }}"
      isExportable: {{ isExportable }}

UPDATE examples

update

Update a certificate.

UPDATE azure.automation.certificate
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a certificate.

REPLACE azure.automation.certificate
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND name = '{{ name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the certificate.

DELETE FROM azure.automation.certificate
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;