Settings - Update

Service:

Defender for Cloud

API Version:

2021-06-01

updating settings about different configurations in Microsoft Defender for Cloud

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

URI Parameters

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

Request Body

The request body can be one of the following:

Name	Description
AlertSyncSettings	Represents an alert sync setting
DataExportSettings	Represents a data export setting

AlertSyncSettings

Represents an alert sync setting

Name	Required	Type	Description
kind	True	string: AlertSyncSettings	the kind of the settings string
properties.enabled	True	boolean	Is the alert sync setting enabled

DataExportSettings

Represents a data export setting

Name	Required	Type	Description
kind	True	string: DataExportSettings	the kind of the settings string
properties.enabled	True	boolean	Is the data export setting enabled

Responses

Name	Type	Description
200 OK	Setting: DataExportSettings AlertSyncSettings	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

Update a setting for subscription

Sample request

HTTP

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

{
  "kind": "DataExportSettings",
  "properties": {
    "enabled": true
  }
}

Sample response

Status code:

200

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

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.

AlertSyncSettings

Object

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

Object

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

Object

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

Object

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

Object

The resource management error additional info.

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