certificates

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

Overview

Name	certificates
Type	Resource
Id	azure.automation.certificates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Gets or sets the properties of the certificate.

list_by_automation_account

Name	Datatype	Description
properties	object	Gets or sets the properties of the certificate.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, certificateName, subscriptionId		Retrieve the certificate identified by certificate name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId		Retrieve a list of certificates.
create_or_update	insert	resourceGroupName, automationAccountName, certificateName, subscriptionId, data__name, data__properties		Create a certificate.
update	update	resourceGroupName, automationAccountName, certificateName, subscriptionId		Update a certificate.
delete	delete	resourceGroupName, automationAccountName, certificateName, subscriptionId		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
automationAccountName	string	The name of the automation account.
certificateName	string	The name of certificate.
resourceGroupName	string	Name of an Azure Resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Retrieve the certificate identified by certificate name.

SELECT
properties
FROM azure.automation.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND certificateName = '{{ certificateName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of certificates.

SELECT
properties
FROM azure.automation.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a certificate.

INSERT INTO azure.automation.certificates (
data__name,
data__properties,
resourceGroupName,
automationAccountName,
certificateName,
subscriptionId
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ certificateName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: certificates
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the certificates resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the certificates resource.
    - name: certificateName
      value: string
      description: Required parameter for the certificates resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the certificates resource.
    - name: name
      value: string
      description: |
        Gets or sets the name of the certificate.
    - name: properties
      value: object
      description: |
        Gets or sets the properties of the certificate.

UPDATE examples

update

Update a certificate.

UPDATE azure.automation.certificates
SET 
data__name = '{{ name }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND certificateName = '{{ certificateName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the certificate.

DELETE FROM azure.automation.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND certificateName = '{{ certificateName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;