sensitivity_settings

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

Overview

Name	sensitivity_settings
Type	Resource
Id	azure.security.sensitivity_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.
mipInformation	object	Microsoft information protection built-in and custom information types, labels, and integration status.
sensitiveInfoTypesIds	array	List of selected sensitive info types' IDs.
sensitivityThresholdLabelId	string	The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
sensitivityThresholdLabelOrder	number	The order of the sensitivity threshold label. Any label at or above this order will be considered sensitive. If set to -1, sensitivity by labels is turned off.
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			Gets data sensitivity settings for sensitive data discovery.
create_or_update	insert	sensitiveInfoTypesIds		Create or update data sensitivity settings for sensitive data discovery.
create_or_update	replace	sensitiveInfoTypesIds		Create or update data sensitivity settings for sensitive data discovery.
list_raw	exec			Gets a list with a single sensitivity settings resource.

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

SELECT examples

get

Gets data sensitivity settings for sensitive data discovery.

SELECT
id,
name,
mipInformation,
sensitiveInfoTypesIds,
sensitivityThresholdLabelId,
sensitivityThresholdLabelOrder,
systemData,
type
FROM azure.security.sensitivity_settings
;

INSERT examples

create_or_update

Create or update data sensitivity settings for sensitive data discovery.

INSERT INTO azure.security.sensitivity_settings (
sensitiveInfoTypesIds,
sensitivityThresholdLabelOrder,
sensitivityThresholdLabelId
)
SELECT 
'{{ sensitiveInfoTypesIds }}' /* required */,
{{ sensitivityThresholdLabelOrder }},
'{{ sensitivityThresholdLabelId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sensitivity_settings
props:
  - name: sensitiveInfoTypesIds
    value:
      - "{{ sensitiveInfoTypesIds }}"
    description: |
      List of selected sensitive info types' IDs. Required.
  - name: sensitivityThresholdLabelOrder
    value: {{ sensitivityThresholdLabelOrder }}
    description: |
      The order of the sensitivity threshold label. Any label at or above this order will be considered sensitive. If set to -1, sensitivity by labels is turned off.
  - name: sensitivityThresholdLabelId
    value: "{{ sensitivityThresholdLabelId }}"
    description: |
      The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.

REPLACE examples

create_or_update

Create or update data sensitivity settings for sensitive data discovery.

REPLACE azure.security.sensitivity_settings
SET 
sensitiveInfoTypesIds = '{{ sensitiveInfoTypesIds }}',
sensitivityThresholdLabelOrder = {{ sensitivityThresholdLabelOrder }},
sensitivityThresholdLabelId = '{{ sensitivityThresholdLabelId }}'
WHERE 
sensitiveInfoTypesIds = '{{ sensitiveInfoTypesIds }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

list_raw

Gets a list with a single sensitivity settings resource.

EXEC azure.security.sensitivity_settings.list_raw 

;