Database Security Alert Policies - Create Or Update

データベースのセキュリティ アラート ポリシーを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/Default?api-version=2020-11-01-preview

URI パラメーター

Name In Required Type Description
databaseName
path True
  • string

セキュリティ アラート ポリシーが定義されているデータベースの名前。

resourceGroupName
path True
  • string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

securityAlertPolicyName
path True

セキュリティ アラート ポリシーの名前。

serverName
path True
  • string

サーバーの名前。

subscriptionId
path True
  • string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True
  • string

要求で使用する API のバージョン。

要求本文

Name Required Type Description
properties.state True

ポリシーの状態を指定します。ポリシーが有効か無効か、ポリシーが特定のデータベースにまだ適用されていないかを指定します。

properties.disabledAlerts
  • string[]

無効になっているアラートの配列を指定します。 使用できる値: Sql_Injection、Sql_Injection_Vulnerability、Access_Anomaly、Data_Exfiltration、Unsafe_Action、Brute_Force

properties.emailAccountAdmins
  • boolean

アラートがアカウント管理者に送信されることを指定します。

properties.emailAddresses
  • string[]

アラートが送信される電子メール アドレスの配列を指定します。

properties.retentionDays
  • integer

脅威検出監査ログに保持する日数を指定します。

properties.storageAccountAccessKey
  • string

脅威検出監査ストレージ アカウントの識別子キーを指定します。

properties.storageEndpoint
  • string

BLOB ストレージ エンドポイント (例: ) を指定します。 https://MyAccount.blob.core.windows.net この BLOB ストレージには、すべての脅威検出監査ログが保持されます。

応答

Name Type Description
200 OK

データベース セキュリティ アラート ポリシーを正常に設定しました。

201 Created

データベース セキュリティ アラート ポリシーが正常に作成されました。

Other Status Codes

エラー応答: ***

  • 400 UpdateNotAllowedOnPausedDatabase - ユーザーが一時停止中のデータベースで更新を実行しようとしました。

  • 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 指定されたストレージ アカウントに対する読み取りまたは書き込みアクセス許可が不十分です。

  • 400 SecurityAlertPoliciesStorageAccountIsDisabled - 脅威検出ポリシーで提供されるストレージ アカウントが無効になっています。

  • 400 SecurityAlertPoliciesInsufficientDiskSpace - データベースにセキュリティ アラート ポリシー メタデータを保存するための十分なディスク領域

  • 400 SecurityAlertPoliciesInvalidStorageAccountName - 指定されたストレージ アカウントが無効であるか、存在しません。

  • 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 指定されたストレージ アカウント アクセス キーが無効です。

  • 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - データベースの脅威検出セキュリティ アラート ポリシー要求が存在しないか、プロパティ オブジェクトがありません。

  • 400 DataSecurityInvalidUserSuppliedParameter - 無効なパラメーター値がクライアントによって提供されました。

  • 400 UpsertDatabaseSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください

  • 400 UpsertDatabaseSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください

  • 404 DatabaseDoesNotExist - ユーザーがこのサーバー インスタンスに存在しないデータベース名を指定しました。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 UpsertDatabaseSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください

  • 409 DatabaseSecurityAlertPolicyInProgress - データベース セキュリティ アラート ポリシーの設定は既に進行中です

  • 409 UpsertDatabaseSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください

  • 500 DatabaseIsUnavailable - 読み込みに失敗しました。 後で再度お試しください。

  • 500 UpsertDatabaseSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください

  • 500 GetDatabaseSecurityAlertPolicyFailed - 脅威検出設定を取得できませんでした

Update a database's threat detection policy with all parameters
Update a database's threat detection policy with minimal parameters

Update a database's threat detection policy with all parameters

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb/securityAlertPolicies/Default?api-version=2020-11-01-preview

{
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "test@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Sql_Injection",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "test@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Sql_Injection",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageAccountAccessKey": "",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "test@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Update a database's threat detection policy with minimal parameters

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb/securityAlertPolicies/Default?api-version=2020-11-01-preview

{
  "properties": {
    "state": "Enabled"
  }
}

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [],
    "disabledAlerts": [],
    "retentionDays": 0,
    "storageAccountAccessKey": "",
    "storageEndpoint": ""
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [],
    "disabledAlerts": [],
    "retentionDays": 0,
    "storageAccountAccessKey": "",
    "storageEndpoint": ""
  }
}

定義

createdByType

リソースを作成した ID の種類。

DatabaseSecurityAlertPolicy

データベース セキュリティ アラート ポリシー。

SecurityAlertPolicyName

セキュリティ アラート ポリシーの名前。

SecurityAlertsPolicyState

ポリシーの状態を指定します。ポリシーが有効か無効か、ポリシーが特定のデータベースにまだ適用されていないかを指定します。

systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DatabaseSecurityAlertPolicy

データベース セキュリティ アラート ポリシー。

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.creationTime
  • string

ポリシーの UTC 作成時刻を指定します。

properties.disabledAlerts
  • string[]

無効になっているアラートの配列を指定します。 使用できる値: Sql_Injection、Sql_Injection_Vulnerability、Access_Anomaly、Data_Exfiltration、Unsafe_Action、Brute_Force

properties.emailAccountAdmins
  • boolean

アラートがアカウント管理者に送信されることを指定します。

properties.emailAddresses
  • string[]

アラートが送信される電子メール アドレスの配列を指定します。

properties.retentionDays
  • integer

脅威検出監査ログに保持する日数を指定します。

properties.state

ポリシーの状態を指定します。ポリシーが有効か無効か、ポリシーが特定のデータベースにまだ適用されていないかを指定します。

properties.storageAccountAccessKey
  • string

脅威検出監査ストレージ アカウントの識別子キーを指定します。

properties.storageEndpoint
  • string

BLOB ストレージ エンドポイント (例: ) を指定します。 https://MyAccount.blob.core.windows.net この BLOB ストレージには、すべての脅威検出監査ログが保持されます。

systemData

SecurityAlertPolicyResource の SystemData。

type
  • string

リソースの種類。

SecurityAlertPolicyName

セキュリティ アラート ポリシーの名前。

Name Type Description
Default
  • string

SecurityAlertsPolicyState

ポリシーの状態を指定します。ポリシーが有効か無効か、ポリシーが特定のデータベースにまだ適用されていないかを指定します。

Name Type Description
Disabled
  • string
Enabled
  • string

systemData

リソースの作成と最後の変更に関連するメタデータ。

Name Type Description
createdAt
  • string

リソース作成のタイムスタンプ (UTC)。

createdBy
  • string

リソースを作成した ID。

createdByType

リソースを作成した ID の種類。

lastModifiedAt
  • string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy
  • string

リソースを最後に変更した ID。

lastModifiedByType

リソースを最後に変更した ID の種類。