Server Security Alert Policies - Create Or Update

Referência

Serviço:: SQL Database

Versão da API:: 2021-11-01

Cria ou atualiza uma política de deteção de ameaças.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
securityAlertPolicyName	path	True	SecurityAlertPolicyName	O nome da política de deteção de ameaças.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.state	True	SecurityAlertsPolicyState	Especifica o estado da política, se ela está habilitada ou desabilitada ou se uma política ainda não foi aplicada no banco de dados específico.
properties.disabledAlerts		string[]	Especifica uma matriz de alertas que estão desabilitados. Os valores permitidos são: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action Brute_Force
properties.emailAccountAdmins		boolean	Especifica que o alerta é enviado aos administradores de conta.
properties.emailAddresses		string[]	Especifica uma matriz de endereços de email para os quais o alerta é enviado.
properties.retentionDays		integer (int32)	Especifica o número de dias a serem mantidos nos logs de auditoria de Deteção de Ameaças.
properties.storageAccountAccessKey		string	Especifica a chave identificador da conta de armazenamento de auditoria de Deteção de Ameaças.
properties.storageEndpoint		string	Especifica o ponto de extremidade de armazenamento de blob (por exemplo, https://MyAccount.blob.core.windows.net). Esse armazenamento de blob armazenará todos os logs de auditoria de Deteção de Ameaças.

Respostas

Name	Tipo	Description
200 OK	ServerSecurityAlertPolicy	Atualizada com êxito a política de deteção de ameaças.
202 Accepted		Criada solicitação para definir a política de deteção de ameaças do servidor.
Other Status Codes		Respostas de erro: *** 400 SecurityAlertPoliciesInvalidStorageAccountName - A conta de armazenamento fornecida não é válida ou não existe. 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - A chave de acesso da conta de armazenamento fornecida não é válida. 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - Não é permitida a configuração de configurações de Deteção de Ameaças do servidor em um servidor com um banco de dados do Data Warehouse pausado 400 SecurityAlertPoliciesInsufficientDiskSpace - Espaço em disco insuficiente para salvar metadados da política de alerta de segurança no banco de dados 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - Permissões de leitura ou gravação insuficientes na conta de armazenamento fornecida. 400 SecurityAlertPoliciesStorageAccountIsDisabled - A conta de armazenamento fornecida na política de deteção de ameaças está desativada. 400 InvalidServerSecurityAlertPolicyCreateRequest - A solicitação de política de alerta de segurança de deteção de ameaças para criar servidor não existe ou não tem nenhum objeto de propriedades. 400 DataSecurityInvalidUserSuppliedParameter - Um valor de parâmetro inválido foi fornecido pelo cliente. 400 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde 400 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde 404 OperationIdNotFound - A operação com Id não existe. 409 ServerSecurityAlertPolicyInProgress - Definir a política de alerta de segurança do servidor já está em andamento 409 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde 409 OperationCancelled - A operação foi cancelada pelo usuário. 409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis. 500 DatabaseIsUnavailable - Falha ao carregar. Tente novamente mais tarde. 500 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde 500 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Por favor, tente novamente a operação. 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

Name

Tipo

Description

200 OK

ServerSecurityAlertPolicy

Atualizada com êxito a política de deteção de ameaças.

202 Accepted

Criada solicitação para definir a política de deteção de ameaças do servidor.

Other Status Codes

Respostas de erro: ***

400 SecurityAlertPoliciesInvalidStorageAccountName - A conta de armazenamento fornecida não é válida ou não existe.
400 SecurityAlertPoliciesInvalidStorageAccountCredentials - A chave de acesso da conta de armazenamento fornecida não é válida.
400 UpdateNotAllowedOnServerContainingPausedDWDatabase - Não é permitida a configuração de configurações de Deteção de Ameaças do servidor em um servidor com um banco de dados do Data Warehouse pausado
400 SecurityAlertPoliciesInsufficientDiskSpace - Espaço em disco insuficiente para salvar metadados da política de alerta de segurança no banco de dados
400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - Permissões de leitura ou gravação insuficientes na conta de armazenamento fornecida.
400 SecurityAlertPoliciesStorageAccountIsDisabled - A conta de armazenamento fornecida na política de deteção de ameaças está desativada.
400 InvalidServerSecurityAlertPolicyCreateRequest - A solicitação de política de alerta de segurança de deteção de ameaças para criar servidor não existe ou não tem nenhum objeto de propriedades.
400 DataSecurityInvalidUserSuppliedParameter - Um valor de parâmetro inválido foi fornecido pelo cliente.
400 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde
400 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde
404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado
404 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde
404 OperationIdNotFound - A operação com Id não existe.
409 ServerSecurityAlertPolicyInProgress - Definir a política de alerta de segurança do servidor já está em andamento
409 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde
409 OperationCancelled - A operação foi cancelada pelo usuário.
409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso.
429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.
429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.
500 DatabaseIsUnavailable - Falha ao carregar. Tente novamente mais tarde.
500 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde
500 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de deteção de ameaças, tente novamente mais tarde
500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Por favor, tente novamente a operação.
503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

Exemplos

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.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),
            com.azure.core.util.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

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 202

Update a server's threat detection policy with minimal parameters

Pedido de amostra

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.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),
            com.azure.core.util.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

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 202

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
SecurityAlertPolicyName	O nome da política de deteção de ameaças.
SecurityAlertsPolicyState	Especifica o estado da política, se ela está habilitada ou desabilitada ou se uma política ainda não foi aplicada no banco de dados específico.
ServerSecurityAlertPolicy	Uma política de alerta de segurança do servidor.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

SecurityAlertPolicyName

Enumeração

O nome da política de deteção de ameaças.

Valor	Description
Default

SecurityAlertsPolicyState

Enumeração

Especifica o estado da política, se ela está habilitada ou desabilitada ou se uma política ainda não foi aplicada no banco de dados específico.

Valor	Description
Disabled
Enabled

ServerSecurityAlertPolicy

Object

Uma política de alerta de segurança do servidor.

Name	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.creationTime	string (date-time)	Especifica a hora de criação UTC da política.
properties.disabledAlerts	string[]	Especifica uma matriz de alertas que estão desabilitados. Os valores permitidos são: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action Brute_Force
properties.emailAccountAdmins	boolean	Especifica que o alerta é enviado aos administradores de conta.
properties.emailAddresses	string[]	Especifica uma matriz de endereços de email para os quais o alerta é enviado.
properties.retentionDays	integer (int32)	Especifica o número de dias a serem mantidos nos logs de auditoria de Deteção de Ameaças.
properties.state	SecurityAlertsPolicyState	Especifica o estado da política, se ela está habilitada ou desabilitada ou se uma política ainda não foi aplicada no banco de dados específico.
properties.storageAccountAccessKey	string	Especifica a chave identificador da conta de armazenamento de auditoria de Deteção de Ameaças.
properties.storageEndpoint	string	Especifica o ponto de extremidade de armazenamento de blob (por exemplo, https://MyAccount.blob.core.windows.net). Esse armazenamento de blob armazenará todos os logs de auditoria de Deteção de Ameaças.
systemData	systemData	SystemData de SecurityAlertPolicyResource.
type	string	Tipo de recurso.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Server Security Alert Policies - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Update a server's threat detection policy with all parameters

Pedido de amostra

Resposta da amostra

Update a server's threat detection policy with minimal parameters

Pedido de amostra

Resposta da amostra

Definições

createdByType

SecurityAlertPolicyName

SecurityAlertsPolicyState

ServerSecurityAlertPolicy

systemData

Recursos adicionais