job_agents

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

Overview

Name	job_agents
Type	Resource
Id	azure.sql.job_agents

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified job agent.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
sku	object	The name and tier of the SKU.
tags	object	Resource tags.

list_by_server

Successfully retrieved the list of job agents.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
sku	object	The name and tier of the SKU.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, jobAgentName, subscriptionId		Gets a job agent.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of job agents in a server.
create_or_update	insert	resourceGroupName, serverName, jobAgentName, subscriptionId, data__location		Creates or updates a job agent.
update	update	resourceGroupName, serverName, jobAgentName, subscriptionId		Updates a job agent.
delete	delete	resourceGroupName, serverName, jobAgentName, subscriptionId		Deletes a job agent.

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
jobAgentName	string	The name of the job agent to be deleted.
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 job agent.

SELECT
location,
properties,
sku,
tags
FROM azure.sql.job_agents
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND jobAgentName = '{{ jobAgentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

Gets a list of job agents in a server.

SELECT
location,
properties,
sku,
tags
FROM azure.sql.job_agents
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a job agent.

INSERT INTO azure.sql.job_agents (
data__location,
data__tags,
data__sku,
data__properties,
resourceGroupName,
serverName,
jobAgentName,
subscriptionId
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ sku }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ jobAgentName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: job_agents
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the job_agents resource.
    - name: serverName
      value: string
      description: Required parameter for the job_agents resource.
    - name: jobAgentName
      value: string
      description: Required parameter for the job_agents resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the job_agents resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: sku
      value: object
      description: |
        The name and tier of the SKU.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates a job agent.

UPDATE azure.sql.job_agents
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND jobAgentName = '{{ jobAgentName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes a job agent.

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