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 (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Workspace setting data
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 (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Workspace setting data
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	subscriptionId, workspaceSettingName	api-version	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	subscriptionId	api-version	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	subscriptionId, workspaceSettingName	api-version	creating settings about where we should store your security data and logs
update	update	subscriptionId, workspaceSettingName	api-version	Settings about where we should store your security data and logs
delete	delete	subscriptionId, workspaceSettingName	api-version	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
subscriptionId	string	Azure subscription ID
workspaceSettingName	string	Name of the security setting
api-version	string	API version for the operation

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,
properties,
systemData,
type
FROM azure.security.workspace_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND workspaceSettingName = '{{ workspaceSettingName }}' -- required
AND api-version = '{{ api-version }}'
;

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,
properties,
systemData,
type
FROM azure.security.workspace_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

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

INSERT INTO azure.security.workspace_settings (
data__properties,
subscriptionId,
workspaceSettingName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ workspaceSettingName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_settings
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the workspace_settings resource.
    - name: workspaceSettingName
      value: string
      description: Required parameter for the workspace_settings resource.
    - name: properties
      value: object
      description: |
        Workspace setting data
    - name: api-version
      value: string
      description: API version for the operation

UPDATE examples

update

Settings about where we should store your security data and logs

UPDATE azure.security.workspace_settings
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND workspaceSettingName = '{{ workspaceSettingName }}' --required
AND api-version = '{{ api-version}}'
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 subscriptionId = '{{ subscriptionId }}' --required
AND workspaceSettingName = '{{ workspaceSettingName }}' --required
AND api-version = '{{ api-version }}'
;