Server Security Alert Policies - Create Or Update

リファレンス

Service:: SQL Database

API Version:: 2021-11-01

脅威検出ポリシーを作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
securityAlertPolicyName	path	True	SecurityAlertPolicyName	脅威検出ポリシーの名前。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

要求本文

名前	必須	型	説明
properties.state	True	SecurityAlertsPolicyState	ポリシーの状態を指定します。ポリシーが有効か無効か、またはポリシーがまだ特定のデータベースに適用されていません。
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 ストレージには、すべての脅威検出監査ログが保持されます。

応答

名前	型	説明
200 OK	ServerSecurityAlertPolicy	脅威検出ポリシーが正常に更新されました。
202 Accepted		サーバー脅威検出ポリシーを設定する要求を作成しました。
Other Status Codes		エラー応答: *** 400 SecurityAlertPoliciesInvalidStorageAccountName - 指定されたストレージアカウントが無効であるか、存在しません。 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 指定されたストレージアカウントアクセスキーが無効です。 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - サーバーの脅威検出設定を、一時停止したData Warehouse データベースのサーバーでは許可されません 400 SecurityAlertPoliciesInsufficientDiskSpace - データベース内のセキュリティアラートポリシーメタデータを保存するためのディスク領域が不足しています 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 指定されたストレージアカウントに対する読み取りまたは書き込みアクセス許可が不十分です。 400 SecurityAlertPoliciesStorageAccountIsDisabled - 脅威検出ポリシーで指定されたストレージアカウントが無効になっています。 400 InvalidServerSecurityAlertPolicyCreateRequest - サーバーの脅威検出セキュリティアラートポリシー要求が存在しないか、プロパティオブジェクトがありません。 400 DataSecurityInvalidUserSuppliedParameter - 無効なパラメーター値がクライアントによって提供されました。 400 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください 400 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 ServerSecurityAlertPolicyInProgress - サーバーセキュリティアラートポリシーの設定は既に進行中です 409 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースで処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。 500 DatabaseIsUnavailable - 読み込みに失敗しました。後で再度お試しください。 500 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください 500 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。 503 TooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。

名前

型

説明

200 OK

ServerSecurityAlertPolicy

脅威検出ポリシーが正常に更新されました。

202 Accepted

サーバー脅威検出ポリシーを設定する要求を作成しました。

Other Status Codes

エラー応答: ***

400 SecurityAlertPoliciesInvalidStorageAccountName - 指定されたストレージアカウントが無効であるか、存在しません。
400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 指定されたストレージアカウントアクセスキーが無効です。
400 UpdateNotAllowedOnServerContainingPausedDWDatabase - サーバーの脅威検出設定を、一時停止したData Warehouse データベースのサーバーでは許可されません
400 SecurityAlertPoliciesInsufficientDiskSpace - データベース内のセキュリティアラートポリシーメタデータを保存するためのディスク領域が不足しています
400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - 指定されたストレージアカウントに対する読み取りまたは書き込みアクセス許可が不十分です。
400 SecurityAlertPoliciesStorageAccountIsDisabled - 脅威検出ポリシーで指定されたストレージアカウントが無効になっています。
400 InvalidServerSecurityAlertPolicyCreateRequest - サーバーの脅威検出セキュリティアラートポリシー要求が存在しないか、プロパティオブジェクトがありません。
400 DataSecurityInvalidUserSuppliedParameter - 無効なパラメーター値がクライアントによって提供されました。
400 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください
400 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください
404 OperationIdNotFound - Id を持つ操作が存在しません。
409 ServerSecurityAlertPolicyInProgress - サーバーセキュリティアラートポリシーの設定は既に進行中です
409 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースで処理できる最大要求を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。
500 DatabaseIsUnavailable - 読み込みに失敗しました。後で再度お試しください。
500 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください
500 UpsertServerSecurityAlertPolicyFailed - 脅威検出設定の保存中にエラーが発生しました。後でもう一度お試しください
500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。
503 TooManyRequests - 使用可能なリソースで処理できる最大要求を超える要求。

例

Update a server's threat detection policy with all parameters

Update a server's threat detection policy with minimal parameters

Update a server's threat detection policy with all parameters

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

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;
import java.util.Arrays;

/** Samples for ServerSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerSecurityAlertsCreateMax.json
     */
    /**
     * Sample code: Update a server's threat detection policy with all parameters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSThreatDetectionPolicyWithAllParameters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerSecurityAlertPolicies().createOrUpdate(
            "securityalert-4799", "securityalert-6440", SecurityAlertPolicyNameAutoGenerated.DEFAULT,
            new ServerSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED)
                .withDisabledAlerts(Arrays.asList("Access_Anomaly", "Usage_Anomaly"))
                .withEmailAddresses(Arrays.asList("testSecurityAlert@microsoft.com")).withEmailAccountAdmins(true)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withRetentionDays(5),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/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": [
      "testSecurityAlert@microsoft.com"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "retentionDays": 5,
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 202

Update a server's threat detection policy with minimal parameters

Sample Request

HTTP
Java

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

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;

/** Samples for ServerSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerSecurityAlertsCreateMin.json
     */
    /**
     * Sample code: Update a server's threat detection policy with minimal parameters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSThreatDetectionPolicyWithMinimalParameters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerSecurityAlertPolicies().createOrUpdate(
            "securityalert-4799", "securityalert-6440", SecurityAlertPolicyNameAutoGenerated.DEFAULT,
            new ServerSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/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": false,
    "emailAddresses": [
      ""
    ],
    "disabledAlerts": [
      ""
    ],
    "retentionDays": 0,
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 202

定義

名前	説明
createdByType	リソースを作成した ID の種類。
SecurityAlertPolicyName	脅威検出ポリシーの名前。
SecurityAlertsPolicyState	ポリシーの状態を指定します。ポリシーが有効か無効か、またはポリシーがまだ特定のデータベースに適用されていません。
ServerSecurityAlertPolicy	サーバーセキュリティアラートポリシー。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

SecurityAlertPolicyName

脅威検出ポリシーの名前。

名前	型	説明
Default	string

SecurityAlertsPolicyState

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

名前	型	説明
Disabled	string
Enabled	string

ServerSecurityAlertPolicy

サーバーセキュリティアラートポリシー。

名前	型	説明
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	SecurityAlertsPolicyState	ポリシーの状態を指定します。ポリシーが有効か無効か、またはポリシーがまだ特定のデータベースに適用されていません。
properties.storageAccountAccessKey	string	脅威検出監査ストレージアカウントの識別子キーを指定します。
properties.storageEndpoint	string	BLOB ストレージエンドポイント (例: ) を指定します。 https://MyAccount.blob.core.windows.net この BLOB ストレージには、すべての脅威検出監査ログが保持されます。
systemData	systemData	SecurityAlertPolicyResource の SystemData。
type	string	リソースの種類。

systemData

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

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

Server Security Alert Policies - Create Or Update

URI パラメーター

要求本文

応答

例

Update a server's threat detection policy with all parameters

Sample Request

Sample Response

Update a server's threat detection policy with minimal parameters

Sample Request

Sample Response

定義

createdByType

SecurityAlertPolicyName

SecurityAlertsPolicyState

ServerSecurityAlertPolicy

systemData

その他のリソース