automations

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

Overview

Name	automations
Type	Resource
Id	azure.security.automations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Security automation data
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Security automation data
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Security automation data
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, automationName	api-version	Retrieves information about the model of a security automation.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for the specified resource group.
list	select	subscriptionId	api-version	Lists all the security automations in the specified subscription. Use the 'nextLink' property in the response to get the next page of security automations for the specified subscription.
create_or_update	insert	subscriptionId, resourceGroupName, automationName	api-version	Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it will be updated.
update	update	subscriptionId, resourceGroupName, automationName	api-version	Updates a security automation
delete	delete	subscriptionId, resourceGroupName, automationName	api-version	Deletes a security automation.
validate	exec	subscriptionId, resourceGroupName, automationName	api-version	Validates the security automation model before create or update. Any validation errors are returned to the client.

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
automationName	string	The security automation name.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

Retrieves information about the model of a security automation.

SELECT
location,
properties,
tags
FROM azure.security.automations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationName = '{{ automationName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for the specified resource group.

SELECT
location,
properties,
tags
FROM azure.security.automations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists all the security automations in the specified subscription. Use the 'nextLink' property in the response to get the next page of security automations for the specified subscription.

SELECT
location,
properties,
tags
FROM azure.security.automations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it will be updated.

INSERT INTO azure.security.automations (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
automationName,
api-version
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ automationName }}',
'{{ api-version }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: automations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the automations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the automations resource.
    - name: automationName
      value: string
      description: Required parameter for the automations resource.
    - name: properties
      value: object
      description: |
        Security automation data
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: api-version
      value: string
      description: API version for the operation

UPDATE examples

update

Updates a security automation

UPDATE azure.security.automations
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND automationName = '{{ automationName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a security automation.

DELETE FROM azure.security.automations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND automationName = '{{ automationName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

validate

Validates the security automation model before create or update. Any validation errors are returned to the client.

EXEC azure.security.automations.validate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationName='{{ automationName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}", 
"tags": "{{ tags }}", 
"location": "{{ location }}"
}'
;