sql_agent

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

Overview

Name	sql_agent
Type	Resource
Id	azure.sql.sql_agent

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.
state	string	The state of Sql Agent. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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, managed_instance_name, subscription_id		Gets current instance sql agent configuration.
create_or_update	insert	resource_group_name, managed_instance_name, subscription_id		Puts new sql agent configuration to instance.
create_or_update	replace	resource_group_name, managed_instance_name, subscription_id		Puts new sql agent configuration to instance.

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
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets current instance sql agent configuration.

SELECT
id,
name,
state,
systemData,
type
FROM azure.sql.sql_agent
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Puts new sql agent configuration to instance.

INSERT INTO azure.sql.sql_agent (
properties,
resource_group_name,
managed_instance_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ managed_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_agent
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_agent resource.
  - name: managed_instance_name
    value: "{{ managed_instance_name }}"
    description: Required parameter for the sql_agent resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_agent resource.
  - name: properties
    description: |
      Resource properties.
    value:
      state: "{{ state }}"

REPLACE examples

create_or_update

Puts new sql agent configuration to instance.

REPLACE azure.sql.sql_agent
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;