Security Contacts - List

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

List all security contact configurations for the subscription

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts?api-version=2023-12-01-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	SecurityContactList	Azure operation completed successfully.
Other Status Codes	Common.CloudError	An unexpected error response.

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

List security contact data

Sample request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts?api-version=2023-12-01-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "default",
      "type": "Microsoft.Security/securityContact",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContact/default",
      "properties": {
        "emails": "john@contoso.com;Jane@contoso.com",
        "isEnabled": true,
        "notificationsByRole": {
          "roles": [
            "Owner",
            "Admin"
          ],
          "state": "On"
        },
        "notificationsSources": [
          {
            "minimalRiskLevel": "Critical",
            "sourceType": "AttackPath"
          },
          {
            "minimalSeverity": "Medium",
            "sourceType": "Alert"
          }
        ],
        "phone": "(214)275-4038"
      }
    }
  ]
}

Definitions

Name	Description
Common.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.).
Common.CloudErrorBody	The error detail.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
MinimalRiskLevel	Defines the minimal attack path risk level which will be sent as email notifications
MinimalSeverity	Defines the minimal alert severity which will be sent as email notifications
NotificationsSourceAlert	Alert notification source
NotificationsSourceAttackPath	Attack path notification source
SecurityContact	Contact details and configurations for notifications coming from Microsoft Defender for Cloud.
SecurityContactList	List of security contacts response
SecurityContactPropertiesNotificationsByRole	Defines whether to send email notifications from Microsoft Defender for Cloud to persons with specific RBAC roles on the subscription.
SecurityContactRole	A possible role to configure sending security notification alerts to
SourceType	The source type that will trigger the notification
State	Defines whether to send email notifications from AMicrosoft Defender for Cloud to persons with specific RBAC roles on the subscription.
systemData	Metadata pertaining to creation and last modification of the resource.

Common.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	Common.CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

Common.CloudErrorBody

Object

The error detail.

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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

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

MinimalRiskLevel

Enumeration

Defines the minimal attack path risk level which will be sent as email notifications

Value	Description
Critical	Get notifications on new attack paths with Critical risk level
High	Get notifications on new attack paths with High or Critical risk level
Medium	Get notifications on new attach paths with Medium, High or Critical risk level
Low	Get notifications on new attach paths with Low, Medium, High or Critical risk level

MinimalSeverity

Enumeration

Defines the minimal alert severity which will be sent as email notifications

Value	Description
High	Get notifications on new alerts with High severity
Medium	Get notifications on new alerts with Medium or High severity
Low	Get notifications on new alerts with Low, Medium or High severity

NotificationsSourceAlert

Object

Alert notification source

Name	Type	Description
minimalSeverity	MinimalSeverity	Defines the minimal alert severity which will be sent as email notifications
sourceType	string: Alert	The source type that will trigger the notification

NotificationsSourceAttackPath

Object

Attack path notification source

Name	Type	Description
minimalRiskLevel	MinimalRiskLevel	Defines the minimal attach path risk level which will be sent as email notifications
sourceType	string: AttackPath	The source type that will trigger the notification