labels

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

Overview

Name	labels
Type	Resource
Id	azure.defender.labels

Fields

The following fields are returned by SELECT queries:

get_by_workspace

Label details.

Name	Datatype	Description
properties	object	Label properties

list_by_workspace

Lists of labels.

Name	Datatype	Description
properties	object	Label properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_workspace	select	resourceGroupName, subscriptionId, workspaceName, labelName		Returns a label in the given workspace.
list_by_workspace	select	resourceGroupName, subscriptionId, workspaceName		Returns a list of labels in the given workspace.
create_and_update	insert	resourceGroupName, subscriptionId, workspaceName, labelName		Create or update a Label.
update	update	resourceGroupName, subscriptionId, workspaceName, labelName		Update a Label.
delete	delete	resourceGroupName, subscriptionId, workspaceName, labelName		Delete a Label.

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
labelName	string	The name of the Label.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the Workspace.

SELECT examples

get_by_workspace

Returns a label in the given workspace.

SELECT
properties
FROM azure.defender.labels
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND labelName = '{{ labelName }}' -- required
;

list_by_workspace

Returns a list of labels in the given workspace.

SELECT
properties
FROM azure.defender.labels
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_and_update

Create or update a Label.

INSERT INTO azure.defender.labels (
data__properties,
resourceGroupName,
subscriptionId,
workspaceName,
labelName
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ labelName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: labels
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the labels resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the labels resource.
    - name: workspaceName
      value: string
      description: Required parameter for the labels resource.
    - name: labelName
      value: string
      description: Required parameter for the labels resource.
    - name: properties
      value: object
      description: |
        Label properties

UPDATE examples

update

Update a Label.

UPDATE azure.defender.labels
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND labelName = '{{ labelName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete a Label.

DELETE FROM azure.defender.labels
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND labelName = '{{ labelName }}' --required
;