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

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.
databaseId	string	Resource ID of the database to store job metadata in. Required.
identity	object	The identity of the job agent.
location	string	The geo-location where the resource lives. Required.
sku	object	The name and tier of the SKU.
state	string	The state of the job agent. Known values are: "Creating", "Ready", "Updating", "Deleting", and "Disabled". (Creating, Ready, Updating, Deleting, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

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.
databaseId	string	Resource ID of the database to store job metadata in. Required.
identity	object	The identity of the job agent.
location	string	The geo-location where the resource lives. Required.
sku	object	The name and tier of the SKU.
state	string	The state of the job agent. Known values are: "Creating", "Ready", "Updating", "Deleting", and "Disabled". (Creating, Ready, Updating, Deleting, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, subscription_id		Gets a job agent.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of job agents in a server.
create_or_update	insert	resource_group_name, server_name, job_agent_name, subscription_id, location		Creates or updates a job agent.
update	update	resource_group_name, server_name, job_agent_name, subscription_id		Updates a job agent.
create_or_update	replace	resource_group_name, server_name, job_agent_name, subscription_id, location		Creates or updates a job agent.
delete	delete	resource_group_name, server_name, job_agent_name, subscription_id		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
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 job agent.

SELECT
id,
name,
databaseId,
identity,
location,
sku,
state,
systemData,
tags,
type
FROM azure.sql.job_agents
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
;

list_by_server

Gets a list of job agents in a server.

SELECT
id,
name,
databaseId,
identity,
location,
sku,
state,
systemData,
tags,
type
FROM azure.sql.job_agents
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a job agent.

INSERT INTO azure.sql.job_agents (
tags,
location,
properties,
sku,
identity,
resource_group_name,
server_name,
job_agent_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ job_agent_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: job_agents
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the job_agents resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the job_agents resource.
  - name: job_agent_name
    value: "{{ job_agent_name }}"
    description: Required parameter for the job_agents resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the job_agents resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Resource properties.
    value:
      databaseId: "{{ databaseId }}"
      state: "{{ state }}"
  - name: sku
    description: |
      The name and tier of the SKU.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
  - name: identity
    description: |
      The identity of the job agent.
    value:
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Updates a job agent.

UPDATE azure.sql.job_agents
SET 
identity = '{{ identity }}',
sku = '{{ sku }}',
tags = '{{ tags }}'
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
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a job agent.

REPLACE azure.sql.job_agents
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}'
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
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a job agent.

DELETE FROM azure.sql.job_agents
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
;