workspaces

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

Overview

Name	workspaces
Type	Resource
Id	azure.defender.workspaces

Fields

The following fields are returned by SELECT queries:

get

Workspace details.

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

list_by_resource_group

List of workspaces.

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

list_by_subscription

List of workspaces.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, workspaceName		Returns a workspace with the given name.
list_by_resource_group	select	resourceGroupName, subscriptionId		Returns a list of workspaces in the given resource group.
list_by_subscription	select	subscriptionId		Returns a list of workspaces under the given subscription.
create_and_update	insert	resourceGroupName, subscriptionId, workspaceName		Create or update a Workspace.
update	update	resourceGroupName, subscriptionId, workspaceName		Update a Workspace.
delete	delete	resourceGroupName, subscriptionId, workspaceName		Delete a Workspace.

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
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

Returns a workspace with the given name.

SELECT
location,
properties,
tags
FROM azure.defender.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_resource_group

Returns a list of workspaces in the given resource group.

SELECT
location,
properties,
tags
FROM azure.defender.workspaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Returns a list of workspaces under the given subscription.

SELECT
location,
properties,
tags
FROM azure.defender.workspaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_and_update

Create or update a Workspace.

INSERT INTO azure.defender.workspaces (
data__properties,
data__tags,
data__location,
resourceGroupName,
subscriptionId,
workspaceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: workspaces
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the workspaces resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the workspaces resource.
    - name: workspaceName
      value: string
      description: Required parameter for the workspaces resource.
    - name: properties
      value: object
      description: |
        Workspace properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a Workspace.

UPDATE azure.defender.workspaces
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a Workspace.

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