Security Contacts - List

List all security contact configurations for the subscription

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

URI Parameters

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

Responses

Name Type Description
200 OK

OK

Other Status Codes

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

List security contact data

Sample Request

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

Sample Response

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

Definitions

AlertNotifications

Defines whether to send email notifications about new security alerts

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.

ErrorAdditionalInfo

The resource management error additional info.

minimalSeverity

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

NotificationsByRole

Defines whether to send email notifications from Microsoft Defender for Cloud to persons with specific RBAC roles on the subscription.

SecurityContact

Contact details and configurations for notifications coming from Microsoft Defender for Cloud.

SecurityContactList

List of security contacts response

state

Defines if email notifications will be sent about new security alerts

AlertNotifications

Defines whether to send email notifications about new security alerts

Name Type Description
minimalSeverity

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

state

Defines if email notifications will be sent about new security alerts

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

The error additional info.

error.code
  • string

The error code.

error.details

The error details.

error.message
  • string

The error message.

error.target
  • string

The error target.

CloudErrorBody

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

minimalSeverity

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

Name Type Description
High
  • string

Get notifications on new alerts with High severity

Low
  • string

Don't get notifications on new alerts with low, medium or high severity

Medium
  • string

Get notifications on new alerts with medium or high severity

NotificationsByRole

Defines whether to send email notifications from Microsoft Defender for Cloud to persons with specific RBAC roles on the subscription.

Name Type Description
roles
  • string[]

Defines which RBAC roles will get email notifications from Microsoft Defender for Cloud. List of allowed RBAC roles:

state

Defines whether to send email notifications from AMicrosoft Defender for Cloud to persons with specific RBAC roles on the subscription.

SecurityContact

Contact details and configurations for notifications coming from Microsoft Defender for Cloud.

Name Type Description
id
  • string

Resource Id

name
  • string

Resource name

properties.alertNotifications

Defines whether to send email notifications about new security alerts

properties.emails
  • string

List of email addresses which will get notifications from Microsoft Defender for Cloud by the configurations defined in this security contact.

properties.notificationsByRole

Defines whether to send email notifications from Microsoft Defender for Cloud to persons with specific RBAC roles on the subscription.

properties.phone
  • string

The security contact's phone number

type
  • string

Resource type

SecurityContactList

List of security contacts response

Name Type Description
nextLink
  • string

The URI to fetch the next page.

value

List of security contacts

state

Defines if email notifications will be sent about new security alerts

Name Type Description
Off
  • string

Don't get notifications on new alerts

On
  • string

Get notifications on new alerts