job_credentials

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

Overview

Name	job_credentials
Type	Resource
Id	azure.sql.job_credentials

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.
password	string	The credential password. Required.
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	The credential user name. Required.

list_by_agent

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.
password	string	The credential password. Required.
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	The credential user name. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, job_agent_name, credential_name, subscription_id		Gets a jobs credential.
list_by_agent	select	resource_group_name, server_name, job_agent_name, subscription_id		Gets a list of jobs credentials.
create_or_update	insert	resource_group_name, server_name, job_agent_name, credential_name, subscription_id		Creates or updates a job credential.
create_or_update	replace	resource_group_name, server_name, job_agent_name, credential_name, subscription_id		Creates or updates a job credential.
delete	delete	resource_group_name, server_name, job_agent_name, credential_name, subscription_id		Deletes a job 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
credential_name	string	The name of the credential. Required.
job_agent_name	string	The name of the job agent to be retrieved. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a jobs credential.

SELECT
id,
name,
password,
systemData,
type,
username
FROM azure.sql.job_credentials
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND job_agent_name = '{{ job_agent_name }}' -- required
AND credential_name = '{{ credential_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_agent

Gets a list of jobs credentials.

SELECT
id,
name,
password,
systemData,
type,
username
FROM azure.sql.job_credentials
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND job_agent_name = '{{ job_agent_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a job credential.

INSERT INTO azure.sql.job_credentials (
properties,
resource_group_name,
server_name,
job_agent_name,
credential_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ job_agent_name }}',
'{{ credential_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: job_credentials
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the job_credentials resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the job_credentials resource.
  - name: job_agent_name
    value: "{{ job_agent_name }}"
    description: Required parameter for the job_credentials resource.
  - name: credential_name
    value: "{{ credential_name }}"
    description: Required parameter for the job_credentials resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the job_credentials resource.
  - name: properties
    description: |
      Resource properties.
    value:
      username: "{{ username }}"
      password: "{{ password }}"

REPLACE examples

create_or_update

Creates or updates a job credential.

REPLACE azure.sql.job_credentials
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND job_agent_name = '{{ job_agent_name }}' --required
AND credential_name = '{{ credential_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a job credential.

DELETE FROM azure.sql.job_credentials
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND job_agent_name = '{{ job_agent_name }}' --required
AND credential_name = '{{ credential_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;