credential

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

Overview

Name	credential
Type	Resource
Id	azure.automation.credential

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.
lastModifiedTime	string (date-time)	Gets the last modified time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userName	string	Gets the user name of the credential.

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.
lastModifiedTime	string (date-time)	Gets the last modified time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userName	string	Gets the user name of the credential.

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, credential_name, subscription_id		Retrieve the credential identified by credential name.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id		Retrieve a list of credentials.
create_or_update	insert	resource_group_name, automation_account_name, credential_name, subscription_id, name, properties		Create a credential.
update	update	resource_group_name, automation_account_name, credential_name, subscription_id		Update a credential.
create_or_update	replace	resource_group_name, automation_account_name, credential_name, subscription_id, name, properties		Create a credential.
delete	delete	resource_group_name, automation_account_name, credential_name, subscription_id		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
automation_account_name	string	The name of the automation account. Required.
credential_name	string	The name of credential. 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 credential identified by credential name.

SELECT
id,
name,
creationTime,
description,
lastModifiedTime,
systemData,
type,
userName
FROM azure.automation.credential
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND credential_name = '{{ credential_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of credentials.

SELECT
id,
name,
creationTime,
description,
lastModifiedTime,
systemData,
type,
userName
FROM azure.automation.credential
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 credential.

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

Manifest

# Description fields are for documentation purposes
- name: credential
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the credential resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the credential resource.
  - name: credential_name
    value: "{{ credential_name }}"
    description: Required parameter for the credential resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the credential resource.
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets the name of the credential. Required.
  - name: properties
    description: |
      Gets or sets the properties of the credential. Required.
    value:
      userName: "{{ userName }}"
      password: "{{ password }}"
      description: "{{ description }}"

UPDATE examples

update

Update a credential.

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

REPLACE examples

create_or_update

Create a credential.

REPLACE azure.automation.credential
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND credential_name = '{{ credential_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 credential.

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