agents

Creates, updates, deletes, gets or lists an agents resource.

Overview

Name	agents
Type	Resource
Id	azure.sql.agents

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved current sql agent configuration.

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, managedInstanceName, subscriptionId		Gets current instance sql agent configuration.
create_or_update	insert	resourceGroupName, managedInstanceName, subscriptionId		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
managedInstanceName	string	The name of the managed instance.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets current instance sql agent configuration.

SELECT
properties
FROM azure.sql.agents
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Puts new sql agent configuration to instance.

INSERT INTO azure.sql.agents (
data__properties,
resourceGroupName,
managedInstanceName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

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