security_operators

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

Overview

Name	security_operators
Type	Resource
Id	azure.security.security_operators

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.
identity	object	Identity for the resource.
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

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.
identity	object	Identity for the resource.
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	pricing_name, security_operator_name, subscription_id		Get a specific security operator for the requested scope.
list	select	pricing_name, subscription_id		Lists Microsoft Defender for Cloud securityOperators in the subscription.
create_or_update	insert	pricing_name, security_operator_name, subscription_id		Creates Microsoft Defender for Cloud security operator on the given scope.
create_or_update	replace	pricing_name, security_operator_name, subscription_id		Creates Microsoft Defender for Cloud security operator on the given scope.
delete	delete	pricing_name, security_operator_name, subscription_id		Delete Microsoft Defender for Cloud securityOperator in the subscription.

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
pricing_name	string	Name of the pricing configuration. Required.
security_operator_name	string	Name of the security operator. Required.
subscription_id	string

SELECT examples

get

Get a specific security operator for the requested scope.

SELECT
id,
name,
identity,
systemData,
type
FROM azure.security.security_operators
WHERE pricing_name = '{{ pricing_name }}' -- required
AND security_operator_name = '{{ security_operator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists Microsoft Defender for Cloud securityOperators in the subscription.

SELECT
id,
name,
identity,
systemData,
type
FROM azure.security.security_operators
WHERE pricing_name = '{{ pricing_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates Microsoft Defender for Cloud security operator on the given scope.

INSERT INTO azure.security.security_operators (
pricing_name,
security_operator_name,
subscription_id
)
SELECT 
'{{ pricing_name }}',
'{{ security_operator_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_operators
props:
  - name: pricing_name
    value: "{{ pricing_name }}"
    description: Required parameter for the security_operators resource.
  - name: security_operator_name
    value: "{{ security_operator_name }}"
    description: Required parameter for the security_operators resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the security_operators resource.

REPLACE examples

create_or_update

Creates Microsoft Defender for Cloud security operator on the given scope.

REPLACE azure.security.security_operators
SET 
-- No updatable properties
WHERE 
pricing_name = '{{ pricing_name }}' --required
AND security_operator_name = '{{ security_operator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
systemData,
type;

DELETE examples

delete

Delete Microsoft Defender for Cloud securityOperator in the subscription.

DELETE FROM azure.security.security_operators
WHERE pricing_name = '{{ pricing_name }}' --required
AND security_operator_name = '{{ security_operator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;