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
- list
Success of the sensitivity settings get
Name | Datatype | Description |
---|---|---|
id | string | The ID of the sensitivity settings |
name | string | The name of the sensitivity settings |
properties | object | The sensitivity settings properties |
type | string | The type of the sensitivity settings |
Success of the sensitivity settings list get
Name | Datatype | Description |
---|---|---|
id | string | The ID of the sensitivity settings |
name | string | The name of the sensitivity settings |
properties | object | The sensitivity settings properties |
type | string | The type of the sensitivity settings |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | api-version | Gets data sensitivity settings for sensitive data discovery | |
list | select | api-version | Gets a list with a single sensitivity settings resource | |
create_or_update | insert | data__sensitiveInfoTypesIds | api-version | Create or update data sensitivity settings for sensitive data discovery |
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 |
---|---|---|
api-version | string | API version for the operation |
SELECT
examples
- get
- list
Gets data sensitivity settings for sensitive data discovery
SELECT
id,
name,
properties,
type
FROM azure.security.sensitivity_settings
WHERE api-version = '{{ api-version }}'
;
Gets a list with a single sensitivity settings resource
SELECT
id,
name,
properties,
type
FROM azure.security.sensitivity_settings
WHERE api-version = '{{ api-version }}'
;
INSERT
examples
- create_or_update
- Manifest
Create or update data sensitivity settings for sensitive data discovery
INSERT INTO azure.security.sensitivity_settings (
data__sensitiveInfoTypesIds,
data__sensitivityThresholdLabelOrder,
data__sensitivityThresholdLabelId,
api-version
)
SELECT
'{{ sensitiveInfoTypesIds }}' /* required */,
{{ sensitivityThresholdLabelOrder }},
'{{ sensitivityThresholdLabelId }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
type
;
# Description fields are for documentation purposes
- name: sensitivity_settings
props:
- name: sensitiveInfoTypesIds
value: array
description: |
List of selected sensitive info types' IDs.
- name: sensitivityThresholdLabelOrder
value: number
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: string
description: |
The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
- name: api-version
value: string
description: API version for the operation