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

Successfully retrieved the job credential.

Name	Datatype	Description
properties	object	Resource properties.

list_by_agent

Successfully retrieved the list of job credentials.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, jobAgentName, credentialName, subscriptionId		Gets a jobs credential.
list_by_agent	select	resourceGroupName, serverName, jobAgentName, subscriptionId		Gets a list of jobs credentials.
create_or_update	insert	resourceGroupName, serverName, jobAgentName, credentialName, subscriptionId		Creates or updates a job credential.
delete	delete	resourceGroupName, serverName, jobAgentName, credentialName, subscriptionId		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
credentialName	string	The name of the credential.
jobAgentName	string	The name of the job agent.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a jobs credential.

SELECT
properties
FROM azure.sql.job_credentials
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND credentialName = '{{ credentialName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_agent

Gets a list of jobs credentials.

SELECT
properties
FROM azure.sql.job_credentials
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a job credential.

INSERT INTO azure.sql.job_credentials (
data__properties,
resourceGroupName,
serverName,
jobAgentName,
credentialName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ jobAgentName }}',
'{{ credentialName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: job_credentials
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the job_credentials resource.
    - name: serverName
      value: string
      description: Required parameter for the job_credentials resource.
    - name: jobAgentName
      value: string
      description: Required parameter for the job_credentials resource.
    - name: credentialName
      value: string
      description: Required parameter for the job_credentials resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the job_credentials resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a job credential.

DELETE FROM azure.sql.job_credentials
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND jobAgentName = '{{ jobAgentName }}' --required
AND credentialName = '{{ credentialName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;