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

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.
members	array	Members of the target group. 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".

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.
members	array	Members of the target group. 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".

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, target_group_name, subscription_id		Gets a target group.
list_by_agent	select	resource_group_name, server_name, job_agent_name, subscription_id		Gets all target groups in an agent.
create_or_update	insert	resource_group_name, server_name, job_agent_name, target_group_name, subscription_id		Creates or updates a target group.
create_or_update	replace	resource_group_name, server_name, job_agent_name, target_group_name, subscription_id		Creates or updates a target group.
delete	delete	resource_group_name, server_name, job_agent_name, target_group_name, subscription_id		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
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
target_group_name	string	The name of the target group. Required.

SELECT examples

get

Gets a target group.

SELECT
id,
name,
members,
systemData,
type
FROM azure.sql.job_target_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND job_agent_name = '{{ job_agent_name }}' -- required
AND target_group_name = '{{ target_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_agent

Gets all target groups in an agent.

SELECT
id,
name,
members,
systemData,
type
FROM azure.sql.job_target_groups
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 target group.

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

Manifest

# Description fields are for documentation purposes
- name: job_target_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the job_target_groups resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the job_target_groups resource.
  - name: job_agent_name
    value: "{{ job_agent_name }}"
    description: Required parameter for the job_target_groups resource.
  - name: target_group_name
    value: "{{ target_group_name }}"
    description: Required parameter for the job_target_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the job_target_groups resource.
  - name: properties
    description: |
      Resource properties.
    value:
      members:
        - membershipType: "{{ membershipType }}"
          type: "{{ type }}"
          serverName: "{{ serverName }}"
          databaseName: "{{ databaseName }}"
          elasticPoolName: "{{ elasticPoolName }}"
          shardMapName: "{{ shardMapName }}"
          refreshCredential: "{{ refreshCredential }}"

REPLACE examples

create_or_update

Creates or updates a target group.

REPLACE azure.sql.job_target_groups
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 target_group_name = '{{ target_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a target group.

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