workspace_manager_assignments

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

Overview

Name	workspace_manager_assignments
Type	Resource
Id	azure.security_insight.workspace_manager_assignments

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.
etag	string	Resource Etag.
items_	array	List of resources included in this workspace manager assignment. Required.
lastJobEndTime	string (date-time)	The time the last job associated to this assignment ended at.
lastJobProvisioningState	string	State of the last job associated to this assignment. Known values are: "Accepted", "InProgress", "Succeeded", "Failed", and "Canceled". (Accepted, InProgress, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetResourceName	string	The resource name of the workspace manager group targeted by the workspace manager assignment. Required.
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.
etag	string	Resource Etag.
items_	array	List of resources included in this workspace manager assignment. Required.
lastJobEndTime	string (date-time)	The time the last job associated to this assignment ended at.
lastJobProvisioningState	string	State of the last job associated to this assignment. Known values are: "Accepted", "InProgress", "Succeeded", "Failed", and "Canceled". (Accepted, InProgress, Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetResourceName	string	The resource name of the workspace manager group targeted by the workspace manager assignment. Required.
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_assignment_name, subscription_id		Gets a workspace manager assignment.
list	select	resource_group_name, workspace_name, subscription_id	$orderby, $top, $skipToken	Get all workspace manager assignments for the Sentinel workspace manager.
create_or_update	insert	resource_group_name, workspace_name, workspace_manager_assignment_name, subscription_id		Creates or updates a workspace manager assignment.
create_or_update	replace	resource_group_name, workspace_name, workspace_manager_assignment_name, subscription_id		Creates or updates a workspace manager assignment.
delete	delete	resource_group_name, workspace_name, workspace_manager_assignment_name, subscription_id		Deletes a workspace manager assignment.

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_assignment_name	string	The name of the workspace manager assignment. 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 assignment.

SELECT
id,
name,
etag,
items_,
lastJobEndTime,
lastJobProvisioningState,
systemData,
targetResourceName,
type
FROM azure.security_insight.workspace_manager_assignments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND workspace_manager_assignment_name = '{{ workspace_manager_assignment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all workspace manager assignments for the Sentinel workspace manager.

SELECT
id,
name,
etag,
items_,
lastJobEndTime,
lastJobProvisioningState,
systemData,
targetResourceName,
type
FROM azure.security_insight.workspace_manager_assignments
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 assignment.

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

Manifest

# Description fields are for documentation purposes
- name: workspace_manager_assignments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_manager_assignments resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_manager_assignments resource.
  - name: workspace_manager_assignment_name
    value: "{{ workspace_manager_assignment_name }}"
    description: Required parameter for the workspace_manager_assignments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_manager_assignments resource.
  - name: properties
    description: |
      The workspace manager assignment object.
    value:
      targetResourceName: "{{ targetResourceName }}"
      lastJobEndTime: "{{ lastJobEndTime }}"
      lastJobProvisioningState: "{{ lastJobProvisioningState }}"
      items_:
        - resourceId: "{{ resourceId }}"

REPLACE examples

create_or_update

Creates or updates a workspace manager assignment.

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

DELETE examples

delete

Deletes a workspace manager assignment.

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