你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Workspace Managed Sql Server Security Alert Policy - Create Or Update

参考

Service:: Synapse

API Version:: 2021-06-01

创建或更新服务器的威胁检测策略。
创建或更新工作区托管 sql server 的威胁检测策略。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/securityAlertPolicies/Default?api-version=2021-06-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
securityAlertPolicyName	path	True	SecurityAlertPolicyName	安全警报策略的名称。
subscriptionId	path	True	string	目标订阅的 ID。
workspaceName	path	True	string	工作区的名称。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
properties.state	True	SecurityAlertPolicyState	指定策略的状态，无论是启用或禁用策略，还是尚未在特定服务器上应用策略
properties.disabledAlerts		string[]	指定禁用的警报数组。允许的值为：Sql_Injection、Sql_Injection_Vulnerability、Access_Anomaly、Data_Exfiltration、Unsafe_Action
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 InvalidServerSecurityAlertPolicyCreateRequest - 创建服务器威胁检测安全警报策略请求不存在或没有属性对象。 400 DataSecurityInvalidUserSuppliedParameter - 客户端提供的参数值无效。 400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 409 ServerSecurityAlertPolicyInProgress - 设置服务器安全警报策略已在进行中 409 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 409 UnsupportedWorkspaceType - 工作区类型不支持的操作。n 500 DatabaseIsUnavailable - 加载失败。请稍后再试。 500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试 500 InternalServerError - 出现问题。

名称

类型

说明

200 OK

ServerSecurityAlertPolicy

已成功更新威胁检测策略。

202 Accepted

已接受。

Other Status Codes

错误响应： ***

400 SecurityAlertPoliciesInvalidStorageAccountName - 提供的存储帐户无效或不存在。
400 SecurityAlertPoliciesInvalidStorageAccountCredentials - 提供的存储帐户访问密钥无效。
400 InvalidServerSecurityAlertPolicyCreateRequest - 创建服务器威胁检测安全警报策略请求不存在或没有属性对象。
400 DataSecurityInvalidUserSuppliedParameter - 客户端提供的参数值无效。
400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
400 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器
404 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
409 ServerSecurityAlertPolicyInProgress - 设置服务器安全警报策略已在进行中
409 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
409 UnsupportedWorkspaceType - 工作区类型不支持的操作。n
500 DatabaseIsUnavailable - 加载失败。请稍后再试。
500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
500 UpsertServerSecurityAlertPolicyFailed - 保存威胁检测设置时出错，请稍后重试
500 InternalServerError - 出现问题。

示例

Update a workspace managed sql server's threat detection policy with all parameters

Update a workspace managed sql server's threat detection policy with minimal parameters

Update a workspace managed sql server's threat detection policy with all parameters

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default?api-version=2021-06-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.resourcemanager.synapse.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.synapse.models.SecurityAlertPolicyState;
import com.azure.resourcemanager.synapse.models.ServerSecurityAlertPolicy;

/** Samples for WorkspaceManagedSqlServerSecurityAlertPolicy CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json
     */
    /**
     * Sample code: Update a workspace managed sql server's threat detection policy with all parameters.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void updateAWorkspaceManagedSqlServerSThreatDetectionPolicyWithAllParameters(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        ServerSecurityAlertPolicy resource =
            manager
                .workspaceManagedSqlServerSecurityAlertPolicies()
                .getWithResponse(
                    "wsg-7398",
                    "testWorkspace",
                    SecurityAlertPolicyNameAutoGenerated.DEFAULT,
                    com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withState(SecurityAlertPolicyState.ENABLED)
            .withStorageAccountAccessKey(
                "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==")
            .apply();
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python workspace_managed_sql_server_security_alert_with_all_parameters.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.workspace_managed_sql_server_security_alert_policy.begin_create_or_update(
        resource_group_name="wsg-7398",
        workspace_name="testWorkspace",
        security_alert_policy_name="Default",
        parameters={
            "properties": {
                "disabledAlerts": ["Access_Anomaly", "Usage_Anomaly"],
                "emailAccountAdmins": True,
                "emailAddresses": ["testSecurityAlert@microsoft.com"],
                "retentionDays": 5,
                "state": "Enabled",
                "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
                "storageEndpoint": "https://mystorage.blob.core.windows.net",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json
if __name__ == "__main__":
    main()

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

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json
func ExampleWorkspaceManagedSQLServerSecurityAlertPolicyClient_BeginCreateOrUpdate_updateAWorkspaceManagedSqlServersThreatDetectionPolicyWithAllParameters() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerSecurityAlertPolicyClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.SecurityAlertPolicyNameAutoGeneratedDefault, armsynapse.ServerSecurityAlertPolicy{
		Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
			DisabledAlerts: []*string{
				to.Ptr("Access_Anomaly"),
				to.Ptr("Usage_Anomaly")},
			EmailAccountAdmins: to.Ptr(true),
			EmailAddresses: []*string{
				to.Ptr("testSecurityAlert@microsoft.com")},
			RetentionDays:           to.Ptr[int32](5),
			State:                   to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerSecurityAlertPolicy = armsynapse.ServerSecurityAlertPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default"),
	// 	Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T04:52:49.520Z"); return t}()),
	// 		DisabledAlerts: []*string{
	// 			to.Ptr("Access_Anomaly"),
	// 			to.Ptr("Usage_Anomaly")},
	// 			EmailAccountAdmins: to.Ptr(true),
	// 			EmailAddresses: []*string{
	// 				to.Ptr("testSecurityAlert@microsoft.com")},
	// 				RetentionDays: to.Ptr[int32](5),
	// 				State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
	// 				StorageAccountAccessKey: to.Ptr(""),
	// 				StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 			},
	// 		}
}

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

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or Update a workspace managed sql server's threat detection policy.
 *
 * @summary Create or Update a workspace managed sql server's threat detection policy.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json
 */
async function updateAWorkspaceManagedSqlServerThreatDetectionPolicyWithAllParameters() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "wsg-7398";
  const workspaceName = "testWorkspace";
  const securityAlertPolicyName = "Default";
  const parameters = {
    disabledAlerts: ["Access_Anomaly", "Usage_Anomaly"],
    emailAccountAdmins: true,
    emailAddresses: ["testSecurityAlert@microsoft.com"],
    retentionDays: 5,
    state: "Enabled",
    storageAccountAccessKey:
      "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    storageEndpoint: "https://mystorage.blob.core.windows.net",
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result =
    await client.workspaceManagedSqlServerSecurityAlertPolicy.beginCreateOrUpdateAndWait(
      resourceGroupName,
      workspaceName,
      securityAlertPolicyName,
      parameters
    );
  console.log(result);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertWithAllParameters.json
// this example is just showing the usage of "WorkspaceManagedSqlServerSecurityAlertPolicy_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SynapseServerSecurityAlertPolicyResource created on azure
// for more information of creating SynapseServerSecurityAlertPolicyResource, please refer to the document of SynapseServerSecurityAlertPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "wsg-7398";
string workspaceName = "testWorkspace";
SqlServerSecurityAlertPolicyName securityAlertPolicyName = SqlServerSecurityAlertPolicyName.Default;
ResourceIdentifier synapseServerSecurityAlertPolicyResourceId = SynapseServerSecurityAlertPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, securityAlertPolicyName);
SynapseServerSecurityAlertPolicyResource synapseServerSecurityAlertPolicy = client.GetSynapseServerSecurityAlertPolicyResource(synapseServerSecurityAlertPolicyResourceId);

// invoke the operation
SynapseServerSecurityAlertPolicyData data = new SynapseServerSecurityAlertPolicyData()
{
    State = SynapseSecurityAlertPolicyState.Enabled,
    DisabledAlerts =
    {
    "Access_Anomaly","Usage_Anomaly"
    },
    EmailAddresses =
    {
    "testSecurityAlert@microsoft.com"
    },
    EnableEmailToAccountAdmins = true,
    StorageEndpoint = "https://mystorage.blob.core.windows.net",
    StorageAccountAccessKey = "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    RetentionDays = 5,
};
ArmOperation<SynapseServerSecurityAlertPolicyResource> lro = await synapseServerSecurityAlertPolicy.UpdateAsync(WaitUntil.Completed, data);
SynapseServerSecurityAlertPolicyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SynapseServerSecurityAlertPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Synapse/workspaces/securityAlertPolicies",
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "testSecurityAlert@microsoft.com"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "creationTime": "2020-10-23T04:52:49.52Z",
    "retentionDays": 5,
    "storageAccountAccessKey": "",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 202

Update a workspace managed sql server's threat detection policy with minimal parameters

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default?api-version=2021-06-01

{
  "properties": {
    "state": "Disabled",
    "emailAccountAdmins": true,
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

import com.azure.resourcemanager.synapse.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.synapse.models.SecurityAlertPolicyState;
import com.azure.resourcemanager.synapse.models.ServerSecurityAlertPolicy;

/** Samples for WorkspaceManagedSqlServerSecurityAlertPolicy CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json
     */
    /**
     * Sample code: Update a workspace managed sql server's threat detection policy with minimal parameters.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void updateAWorkspaceManagedSqlServerSThreatDetectionPolicyWithMinimalParameters(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        ServerSecurityAlertPolicy resource =
            manager
                .workspaceManagedSqlServerSecurityAlertPolicies()
                .getWithResponse(
                    "wsg-7398",
                    "testWorkspace",
                    SecurityAlertPolicyNameAutoGenerated.DEFAULT,
                    com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withState(SecurityAlertPolicyState.DISABLED)
            .withStorageAccountAccessKey(
                "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==")
            .apply();
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python workspace_managed_sql_server_security_alert_create_with_min_parameters.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.workspace_managed_sql_server_security_alert_policy.begin_create_or_update(
        resource_group_name="wsg-7398",
        workspace_name="testWorkspace",
        security_alert_policy_name="Default",
        parameters={
            "properties": {
                "emailAccountAdmins": True,
                "state": "Disabled",
                "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
                "storageEndpoint": "https://mystorage.blob.core.windows.net",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json
if __name__ == "__main__":
    main()

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

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json
func ExampleWorkspaceManagedSQLServerSecurityAlertPolicyClient_BeginCreateOrUpdate_updateAWorkspaceManagedSqlServersThreatDetectionPolicyWithMinimalParameters() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewWorkspaceManagedSQLServerSecurityAlertPolicyClient().BeginCreateOrUpdate(ctx, "wsg-7398", "testWorkspace", armsynapse.SecurityAlertPolicyNameAutoGeneratedDefault, armsynapse.ServerSecurityAlertPolicy{
		Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
			EmailAccountAdmins:      to.Ptr(true),
			State:                   to.Ptr(armsynapse.SecurityAlertPolicyStateDisabled),
			StorageAccountAccessKey: to.Ptr("sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD=="),
			StorageEndpoint:         to.Ptr("https://mystorage.blob.core.windows.net"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServerSecurityAlertPolicy = armsynapse.ServerSecurityAlertPolicy{
	// 	Name: to.Ptr("Default"),
	// 	Type: to.Ptr("Microsoft.Synapse/workspaces/securityAlertPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default"),
	// 	Properties: &armsynapse.ServerSecurityAlertPolicyProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-23T04:52:49.520Z"); return t}()),
	// 		DisabledAlerts: []*string{
	// 			to.Ptr("")},
	// 			EmailAccountAdmins: to.Ptr(true),
	// 			EmailAddresses: []*string{
	// 				to.Ptr("")},
	// 				RetentionDays: to.Ptr[int32](0),
	// 				State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
	// 				StorageAccountAccessKey: to.Ptr(""),
	// 				StorageEndpoint: to.Ptr("https://mystorage.blob.core.windows.net"),
	// 			},
	// 		}
}

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

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or Update a workspace managed sql server's threat detection policy.
 *
 * @summary Create or Update a workspace managed sql server's threat detection policy.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json
 */
async function updateAWorkspaceManagedSqlServerThreatDetectionPolicyWithMinimalParameters() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "wsg-7398";
  const workspaceName = "testWorkspace";
  const securityAlertPolicyName = "Default";
  const parameters = {
    emailAccountAdmins: true,
    state: "Disabled",
    storageAccountAccessKey:
      "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    storageEndpoint: "https://mystorage.blob.core.windows.net",
  };
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result =
    await client.workspaceManagedSqlServerSecurityAlertPolicy.beginCreateOrUpdateAndWait(
      resourceGroupName,
      workspaceName,
      securityAlertPolicyName,
      parameters
    );
  console.log(result);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/WorkspaceManagedSqlServerSecurityAlertCreateWithMinParameters.json
// this example is just showing the usage of "WorkspaceManagedSqlServerSecurityAlertPolicy_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SynapseServerSecurityAlertPolicyResource created on azure
// for more information of creating SynapseServerSecurityAlertPolicyResource, please refer to the document of SynapseServerSecurityAlertPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "wsg-7398";
string workspaceName = "testWorkspace";
SqlServerSecurityAlertPolicyName securityAlertPolicyName = SqlServerSecurityAlertPolicyName.Default;
ResourceIdentifier synapseServerSecurityAlertPolicyResourceId = SynapseServerSecurityAlertPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, securityAlertPolicyName);
SynapseServerSecurityAlertPolicyResource synapseServerSecurityAlertPolicy = client.GetSynapseServerSecurityAlertPolicyResource(synapseServerSecurityAlertPolicyResourceId);

// invoke the operation
SynapseServerSecurityAlertPolicyData data = new SynapseServerSecurityAlertPolicyData()
{
    State = SynapseSecurityAlertPolicyState.Disabled,
    EnableEmailToAccountAdmins = true,
    StorageEndpoint = "https://mystorage.blob.core.windows.net",
    StorageAccountAccessKey = "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
};
ArmOperation<SynapseServerSecurityAlertPolicyResource> lro = await synapseServerSecurityAlertPolicy.UpdateAsync(WaitUntil.Completed, data);
SynapseServerSecurityAlertPolicyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SynapseServerSecurityAlertPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/wsg-7398/providers/Microsoft.Synapse/workspaces/testWorkspace/securityAlertPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Synapse/workspaces/securityAlertPolicies",
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      ""
    ],
    "disabledAlerts": [
      ""
    ],
    "creationTime": "2020-10-23T04:52:49.52Z",
    "retentionDays": 0,
    "storageAccountAccessKey": "",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 202

定义

名称	说明
SecurityAlertPolicyName	安全警报策略的名称。
SecurityAlertPolicyState	指定策略的状态，无论是启用或禁用策略，还是尚未在特定服务器上应用策略
ServerSecurityAlertPolicy	工作区托管的 Sql Server 安全警报策略。

SecurityAlertPolicyName

安全警报策略的名称。

名称	类型	说明
Default	string

SecurityAlertPolicyState

指定策略的状态，无论是启用或禁用策略，还是尚未在特定服务器上应用策略

名称	类型	说明
Disabled	string
Enabled	string
New	string

ServerSecurityAlertPolicy

工作区托管的 Sql Server 安全警报策略。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.creationTime	string	指定策略的 UTC 创建时间。
properties.disabledAlerts	string[]	指定禁用的警报数组。允许的值为：Sql_Injection、Sql_Injection_Vulnerability、Access_Anomaly、Data_Exfiltration、Unsafe_Action
properties.emailAccountAdmins	boolean	指定将警报发送到帐户管理员。
properties.emailAddresses	string[]	指定警报发送到的电子邮件地址数组。
properties.retentionDays	integer	指定要在威胁检测审核日志中保留的天数。
properties.state	SecurityAlertPolicyState	指定策略的状态，无论是启用或禁用策略，还是尚未在特定服务器上应用策略
properties.storageAccountAccessKey	string	指定威胁检测审核存储帐户的标识符密钥。
properties.storageEndpoint	string	指定 blob 存储终结点 (例如 https://MyAccount.blob.core.windows.net) 。此 Blob 存储将保存所有威胁检测审核日志。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

Workspace Managed Sql Server Security Alert Policy - Create Or Update

URI 参数

请求正文

响应

示例

Update a workspace managed sql server's threat detection policy with all parameters

Sample Request

Sample Response

Update a workspace managed sql server's threat detection policy with minimal parameters

Sample Request

Sample Response

定义

SecurityAlertPolicyName

SecurityAlertPolicyState

ServerSecurityAlertPolicy

其他资源