Share via

SqlPoolSecurityAlertPolicy interface

  • Reference
Package:
@azure/arm-synapse

A Sql pool security alert policy.

Extends
ProxyResource

Properties

creationTime

Specifies the UTC creation time of the policy. NOTE: This property will not be serialized. It can only be populated by the server.
disabledAlerts

Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action
emailAccountAdmins

Specifies that the alert is sent to the account administrators.
emailAddresses

Specifies an array of e-mail addresses to which the alert is sent.
retentionDays

Specifies the number of days to keep in the Threat Detection audit logs.
state

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool.
storageAccountAccessKey

Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

creationTime

Specifies the UTC creation time of the policy. NOTE: This property will not be serialized. It can only be populated by the server.

creationTime?: Date

Property Value

Date

disabledAlerts

Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action

disabledAlerts?: string[]

Property Value

string[]

emailAccountAdmins

Specifies that the alert is sent to the account administrators.

emailAccountAdmins?: boolean

Property Value

boolean

emailAddresses

Specifies an array of e-mail addresses to which the alert is sent.

emailAddresses?: string[]

Property Value

string[]

retentionDays

Specifies the number of days to keep in the Threat Detection audit logs.

retentionDays?: number

Property Value

number

state

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool.

state?: SecurityAlertPolicyState

Property Value

SecurityAlertPolicyState

storageAccountAccessKey

Specifies the identifier key of the Threat Detection audit storage account.

storageAccountAccessKey?: string

Property Value

string

storageEndpoint

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

storageEndpoint?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type