workspace_manager_assignment_jobs

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

Overview

Name	workspace_manager_assignment_jobs
Type	Resource
Id	azure.security_insight.workspace_manager_assignment_jobs

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.
endTime	string (date-time)	The time the job completed.
errorMessage	string	Message to describe error, if an error exists.
etag	string	Etag of the azure resource.
items_	array	List of items published by the job.
provisioningState	string	State of the job. Known values are: "Accepted", "InProgress", "Succeeded", "Failed", and "Canceled". (Accepted, InProgress, Succeeded, Failed, Canceled)
startTime	string (date-time)	The time the job started.
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.
endTime	string (date-time)	The time the job completed.
errorMessage	string	Message to describe error, if an error exists.
etag	string	Etag of the azure resource.
items_	array	List of items published by the job.
provisioningState	string	State of the job. Known values are: "Accepted", "InProgress", "Succeeded", "Failed", and "Canceled". (Accepted, InProgress, Succeeded, Failed, Canceled)
startTime	string (date-time)	The time the job started.
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_assignment_name, job_name, subscription_id		Gets a job.
list	select	resource_group_name, workspace_name, workspace_manager_assignment_name, subscription_id	$orderby, $top, $skipToken	Get all jobs for the specified workspace manager assignment.
create	insert	resource_group_name, workspace_name, workspace_manager_assignment_name, subscription_id		Create a job for the specified workspace manager assignment.
delete	delete	resource_group_name, workspace_name, workspace_manager_assignment_name, job_name, subscription_id		Deletes the specified job from the specified 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
job_name	string	The job name. Required.
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 job.

SELECT
id,
name,
endTime,
errorMessage,
etag,
items_,
provisioningState,
startTime,
systemData,
type
FROM azure.security_insight.workspace_manager_assignment_jobs
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 job_name = '{{ job_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all jobs for the specified workspace manager assignment.

SELECT
id,
name,
endTime,
errorMessage,
etag,
items_,
provisioningState,
startTime,
systemData,
type
FROM azure.security_insight.workspace_manager_assignment_jobs
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
AND $orderby = '{{ $orderby }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Create a job for the specified workspace manager assignment.

INSERT INTO azure.security_insight.workspace_manager_assignment_jobs (
resource_group_name,
workspace_name,
workspace_manager_assignment_name,
subscription_id
)
SELECT 
'{{ 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_assignment_jobs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_manager_assignment_jobs resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_manager_assignment_jobs resource.
  - name: workspace_manager_assignment_name
    value: "{{ workspace_manager_assignment_name }}"
    description: Required parameter for the workspace_manager_assignment_jobs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_manager_assignment_jobs resource.

DELETE examples

delete

Deletes the specified job from the specified workspace manager assignment.

DELETE FROM azure.security_insight.workspace_manager_assignment_jobs
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 job_name = '{{ job_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;