workspace_manager_groups

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

Overview

Name	workspace_manager_groups
Type	Resource
Id	azure.security_insight.workspace_manager_groups

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.
description	string	The description of the workspace manager group.
displayName	string	The display name of the workspace manager group. Required.
etag	string	Resource Etag.
memberResourceNames	array	The names of the workspace manager members participating in this group. Required.
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.
description	string	The description of the workspace manager group.
displayName	string	The display name of the workspace manager group. Required.
etag	string	Resource Etag.
memberResourceNames	array	The names of the workspace manager members participating in this group. Required.
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	resource_group_name, workspace_name, workspace_manager_group_name, subscription_id		Gets a workspace manager group.
list	select	resource_group_name, workspace_name, subscription_id	$orderby, $top, $skipToken	Gets all workspace manager groups in the Sentinel workspace manager.
create_or_update	insert	resource_group_name, workspace_name, workspace_manager_group_name, subscription_id		Creates or updates a workspace manager group.
create_or_update	replace	resource_group_name, workspace_name, workspace_manager_group_name, subscription_id		Creates or updates a workspace manager group.
delete	delete	resource_group_name, workspace_name, workspace_manager_group_name, subscription_id		Deletes a workspace manager group.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_manager_group_name	string	The name of the workspace manager group. Required.
workspace_name	string	The name of the workspace. Required.
$orderby	string	Sorts the results. Optional. Default value is None.
$skipToken	string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. Default value is None.
$top	integer	Returns only the first n results. Optional. Default value is None.

SELECT examples

get

Gets a workspace manager group.

SELECT
id,
name,
description,
displayName,
etag,
memberResourceNames,
systemData,
type
FROM azure.security_insight.workspace_manager_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND workspace_manager_group_name = '{{ workspace_manager_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all workspace manager groups in the Sentinel workspace manager.

SELECT
id,
name,
description,
displayName,
etag,
memberResourceNames,
systemData,
type
FROM azure.security_insight.workspace_manager_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $orderby = '{{ $orderby }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a workspace manager group.

INSERT INTO azure.security_insight.workspace_manager_groups (
properties,
resource_group_name,
workspace_name,
workspace_manager_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ workspace_manager_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_manager_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_manager_groups resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_manager_groups resource.
  - name: workspace_manager_group_name
    value: "{{ workspace_manager_group_name }}"
    description: Required parameter for the workspace_manager_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_manager_groups resource.
  - name: properties
    description: |
      The workspace manager group object.
    value:
      description: "{{ description }}"
      displayName: "{{ displayName }}"
      memberResourceNames:
        - "{{ memberResourceNames }}"

REPLACE examples

create_or_update

Creates or updates a workspace manager group.

REPLACE azure.security_insight.workspace_manager_groups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND workspace_manager_group_name = '{{ workspace_manager_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a workspace manager group.

DELETE FROM azure.security_insight.workspace_manager_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND workspace_manager_group_name = '{{ workspace_manager_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;