Server Security Alert Policies - Create Or Update

Cria ou atualiza uma política de detecçã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 de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

securityAlertPolicyName
path True

SecurityAlertPolicyName

O nome da política de detecçã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 da solicitação

Nome Obrigatório Tipo Description
properties.state True

SecurityAlertsPolicyState

Especifica o estado da política, se ela está habilitada ou desabilitada ou 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 da conta.

properties.emailAddresses

string[]

Especifica uma matriz de endereços de email para os quais o alerta é enviado.

properties.retentionDays

integer

Especifica o número de dias a serem mantidos nos logs de auditoria de Detecção de Ameaças.

properties.storageAccountAccessKey

string

Especifica a chave de identificador da conta de armazenamento de auditoria de Detecção de Ameaças.

properties.storageEndpoint

string

Especifica o ponto de extremidade de armazenamento de blobs (por exemplo, https://MyAccount.blob.core.windows.net). Esse armazenamento de blobs conterá todos os logs de auditoria de Detecção de Ameaças.

Respostas

Nome Tipo Description
200 OK

ServerSecurityAlertPolicy

A política de detecção de ameaças foi atualizada com êxito.

202 Accepted

Solicitação criada para definir a política de detecçã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 - A configuração das configurações de Detecção de Ameaças do servidor não é permitida em um servidor com um banco de dados 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 detecção de ameaças está desabilitada.

  • 400 InvalidServerSecurityAlertPolicyCreateRequest - A solicitação de política de alerta de segurança de Detecção de Ameaças do servidor de criação não existe ou não tem nenhum objeto properties.

  • 400 DataSecurityInvalidUserSuppliedParameter - Um valor de parâmetro inválido foi fornecido pelo cliente.

  • 400 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de detecção de ameaças. Tente novamente mais tarde

  • 400 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de detecçã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 detecção de ameaças. Tente novamente mais tarde

  • 404 OperationIdNotFound - A operação com Id não existe.

  • 409 ServerSecurityAlertPolicyInProgress - Definir política de alerta de segurança do servidor já está em andamento

  • 409 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de detecçã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 por recursos disponíveis.

  • 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis.

  • 500 DatabaseIsUnavailable – Falha ao carregar. Tente novamente mais tarde.

  • 500 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de detecção de ameaças. Tente novamente mais tarde

  • 500 UpsertServerSecurityAlertPolicyFailed - Ocorreu um erro ao salvar as configurações de detecção de ameaças. Tente novamente mais tarde

  • 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente.

  • 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas por 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

Sample Request

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"
  }
}

Sample Response

{
  "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"
  }
}

Update a server'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/securityAlertPolicies/Default?api-version=2021-11-01

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

Sample Response

{
  "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"
  }
}

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.

SecurityAlertPolicyName

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

SecurityAlertsPolicyState

Especifica o estado da política, se ela está habilitada ou desabilitada ou 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 relativos à criação e à última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

SecurityAlertPolicyName

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

Nome Tipo Description
Default

string

SecurityAlertsPolicyState

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

Nome Tipo Description
Disabled

string

Enabled

string

ServerSecurityAlertPolicy

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

Nome Tipo Description
id

string

ID do recurso.

name

string

Nome do recurso.

properties.creationTime

string

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 da conta.

properties.emailAddresses

string[]

Especifica uma matriz de endereços de email para os quais o alerta é enviado.

properties.retentionDays

integer

Especifica o número de dias a serem mantidos nos logs de auditoria de Detecção de Ameaças.

properties.state

SecurityAlertsPolicyState

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

properties.storageAccountAccessKey

string

Especifica a chave de identificador da conta de armazenamento de auditoria de Detecção de Ameaças.

properties.storageEndpoint

string

Especifica o ponto de extremidade de armazenamento de blobs (por exemplo, https://MyAccount.blob.core.windows.net). Esse armazenamento de blobs conterá todos os logs de auditoria de Detecção de Ameaças.

systemData

systemData

SystemData de SecurityAlertPolicyResource.

type

string

Tipo de recurso.

systemData

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

Nome Tipo Description
createdAt

string

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

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.