job_target_groups

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

Overview

Name	job_target_groups
Type	Resource
Id	azure.sql.job_target_groups

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the target group.

Name	Datatype	Description
properties	object	Resource properties.

list_by_agent

Successfully retrieved the list of target groups.

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, targetGroupName, subscriptionId		Gets a target group.
list_by_agent	select	resourceGroupName, serverName, jobAgentName, subscriptionId		Gets all target groups in an agent.
create_or_update	insert	resourceGroupName, serverName, jobAgentName, targetGroupName, subscriptionId		Creates or updates a target group.
delete	delete	resourceGroupName, serverName, jobAgentName, targetGroupName, subscriptionId		Deletes a target group.

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.
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.
targetGroupName	string	The name of the target group.

SELECT examples

get

Gets a target group.

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

list_by_agent

Gets all target groups in an agent.

SELECT
properties
FROM azure.sql.job_target_groups
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 target group.

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

Manifest

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

DELETE examples

delete

Deletes a target group.

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