workspace_settings

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

Overview

Name	workspace_settings
Type	Resource
Id	azure.security.workspace_settings

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.
scope	string	All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope. 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".
workspaceId	string	The full Azure ID of the workspace to save the data in. Required.

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.
scope	string	All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope. 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".
workspaceId	string	The full Azure ID of the workspace to save the data in. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workspace_setting_name, subscription_id		Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set.
list	select	subscription_id		Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set.
create	insert	workspace_setting_name, subscription_id		creating settings about where we should store your security data and logs.
update	update	workspace_setting_name, subscription_id		Settings about where we should store your security data and logs.
delete	delete	workspace_setting_name, subscription_id		Deletes the custom workspace settings for this subscription. new VMs will report to the default 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
subscription_id	string
workspace_setting_name	string	Name of the security setting. Required.

SELECT examples

get

Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set.

SELECT
id,
name,
scope,
systemData,
type,
workspaceId
FROM azure.security.workspace_settings
WHERE workspace_setting_name = '{{ workspace_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set.

SELECT
id,
name,
scope,
systemData,
type,
workspaceId
FROM azure.security.workspace_settings
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

creating settings about where we should store your security data and logs.

INSERT INTO azure.security.workspace_settings (
properties,
workspace_setting_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ workspace_setting_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_settings
props:
  - name: workspace_setting_name
    value: "{{ workspace_setting_name }}"
    description: Required parameter for the workspace_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_settings resource.
  - name: properties
    description: |
      Workspace setting data.
    value:
      workspaceId: "{{ workspaceId }}"
      scope: "{{ scope }}"

UPDATE examples

update

Settings about where we should store your security data and logs.

UPDATE azure.security.workspace_settings
SET 
properties = '{{ properties }}'
WHERE 
workspace_setting_name = '{{ workspace_setting_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the custom workspace settings for this subscription. new VMs will report to the default workspace.

DELETE FROM azure.security.workspace_settings
WHERE workspace_setting_name = '{{ workspace_setting_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;