credentials

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

Overview

Name	credentials
Type	Resource
Id	azure.automation.credentials

Fields

The following fields are returned by SELECT queries:

get

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

list_by_automation_account

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, credentialName, subscriptionId		Retrieve the credential identified by credential name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId		Retrieve a list of credentials.
create_or_update	insert	resourceGroupName, automationAccountName, credentialName, subscriptionId, data__name, data__properties		Create a credential.
update	update	resourceGroupName, automationAccountName, credentialName, subscriptionId		Update a credential.
delete	delete	resourceGroupName, automationAccountName, credentialName, subscriptionId		Delete the credential.

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.
credentialName	string	The name of credential.
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 credential identified by credential name.

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

list_by_automation_account

Retrieve a list of credentials.

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

INSERT examples

create_or_update

Create a credential.

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

Manifest

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

UPDATE examples

update

Update a credential.

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

DELETE examples

delete

Delete the credential.

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