Settings - List

Reference

Service:: Defender for Cloud

API Version:: 2021-06-01

Settings about different configurations in Microsoft Defender for Cloud

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings?api-version=2021-06-01

URI Parameters

Name In Required Type Description

Name	In	Required	Type	Description
subscriptionId	path	True	string	Azure subscription ID Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API version for the operation

subscriptionId

path

True

string

Azure subscription ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

API version for the operation

Responses

Name	Type	Description
200 OK	SettingsList	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get settings of subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings?api-version=2021-06-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP",
      "name": "WDATP",
      "kind": "DataExportSettings",
      "type": "Microsoft.Security/settings",
      "properties": {
        "enabled": false
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/Sentinel",
      "name": "Sentinel",
      "kind": "AlertSyncSettings",
      "type": "Microsoft.Security/settings",
      "properties": {
        "enabled": false
      }
    }
  ]
}

Definitions

Name	Description
AlertSyncSettings	Represents an alert sync setting
CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
CloudErrorBody	The error detail.
DataExportSettings	Represents a data export setting
ErrorAdditionalInfo	The resource management error additional info.
SettingsList	Subscription settings list.

AlertSyncSettings

Represents an alert sync setting

Name	Type	Description
id	string	Resource Id
kind	string: AlertSyncSettings	the kind of the settings string
name	string	Resource name
properties.enabled	boolean	Is the alert sync setting enabled
type	string	Resource type

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

DataExportSettings

Represents a data export setting

Name	Type	Description
id	string	Resource Id
kind	string: DataExportSettings	the kind of the settings string
name	string	Resource name
properties.enabled	boolean	Is the data export setting enabled
type	string	Resource type

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

SettingsList

Subscription settings list.

Name	Type	Description
nextLink	string	The URI to fetch the next page.
value	Setting[]: AlertSyncSettings[] DataExportSettings[]	The settings list.