operators

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

Overview

Name	operators
Type	Resource
Id	azure.security.operators

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/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 (arm-id)	Fully qualified resource ID for the resource. E.g. "/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	subscriptionId, pricingName, securityOperatorName	api-version	Get a specific security operator for the requested scope.
list	select	subscriptionId, pricingName	api-version	Lists Microsoft Defender for Cloud securityOperators in the subscription.
create_or_update	insert	subscriptionId, pricingName, securityOperatorName	api-version	Creates Microsoft Defender for Cloud security operator on the given scope.
delete	delete	subscriptionId, pricingName, securityOperatorName	api-version	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
pricingName	string	name of the pricing configuration
securityOperatorName	string	name of the securityOperator
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

Get a specific security operator for the requested scope.

SELECT
id,
name,
identity,
systemData,
type
FROM azure.security.operators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND pricingName = '{{ pricingName }}' -- required
AND securityOperatorName = '{{ securityOperatorName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Lists Microsoft Defender for Cloud securityOperators in the subscription.

SELECT
id,
name,
identity,
systemData,
type
FROM azure.security.operators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND pricingName = '{{ pricingName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.security.operators (
subscriptionId,
pricingName,
securityOperatorName,
api-version
)
SELECT 
'{{ subscriptionId }}',
'{{ pricingName }}',
'{{ securityOperatorName }}',
'{{ api-version }}'
RETURNING
id,
name,
identity,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: operators
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the operators resource.
    - name: pricingName
      value: string
      description: Required parameter for the operators resource.
    - name: securityOperatorName
      value: string
      description: Required parameter for the operators resource.
    - name: api-version
      value: string
      description: API version for the operation

DELETE examples

delete

Delete Microsoft Defender for Cloud securityOperator in the subscription.

DELETE FROM azure.security.operators
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND pricingName = '{{ pricingName }}' --required
AND securityOperatorName = '{{ securityOperatorName }}' --required
AND api-version = '{{ api-version }}'
;