azure-native.sql.getDatabaseSecurityAlertPolicy
Explore with Pulumi AI
Gets a database’s security alert policy.
Uses Azure REST API version 2023-08-01.
Other available API versions: 2018-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.
Using getDatabaseSecurityAlertPolicy
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDatabaseSecurityAlertPolicy(args: GetDatabaseSecurityAlertPolicyArgs, opts?: InvokeOptions): Promise<GetDatabaseSecurityAlertPolicyResult>
function getDatabaseSecurityAlertPolicyOutput(args: GetDatabaseSecurityAlertPolicyOutputArgs, opts?: InvokeOptions): Output<GetDatabaseSecurityAlertPolicyResult>def get_database_security_alert_policy(database_name: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       security_alert_policy_name: Optional[str] = None,
                                       server_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetDatabaseSecurityAlertPolicyResult
def get_database_security_alert_policy_output(database_name: Optional[pulumi.Input[str]] = None,
                                       resource_group_name: Optional[pulumi.Input[str]] = None,
                                       security_alert_policy_name: Optional[pulumi.Input[str]] = None,
                                       server_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseSecurityAlertPolicyResult]func LookupDatabaseSecurityAlertPolicy(ctx *Context, args *LookupDatabaseSecurityAlertPolicyArgs, opts ...InvokeOption) (*LookupDatabaseSecurityAlertPolicyResult, error)
func LookupDatabaseSecurityAlertPolicyOutput(ctx *Context, args *LookupDatabaseSecurityAlertPolicyOutputArgs, opts ...InvokeOption) LookupDatabaseSecurityAlertPolicyResultOutput> Note: This function is named LookupDatabaseSecurityAlertPolicy in the Go SDK.
public static class GetDatabaseSecurityAlertPolicy 
{
    public static Task<GetDatabaseSecurityAlertPolicyResult> InvokeAsync(GetDatabaseSecurityAlertPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseSecurityAlertPolicyResult> Invoke(GetDatabaseSecurityAlertPolicyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDatabaseSecurityAlertPolicyResult> getDatabaseSecurityAlertPolicy(GetDatabaseSecurityAlertPolicyArgs args, InvokeOptions options)
public static Output<GetDatabaseSecurityAlertPolicyResult> getDatabaseSecurityAlertPolicy(GetDatabaseSecurityAlertPolicyArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:sql:getDatabaseSecurityAlertPolicy
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Database
Name string - The name of the database for which the security alert policy is defined.
 - Resource
Group stringName  - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
 - Security
Alert stringPolicy Name  - The name of the security alert policy.
 - Server
Name string - The name of the server.
 
- Database
Name string - The name of the database for which the security alert policy is defined.
 - Resource
Group stringName  - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
 - Security
Alert stringPolicy Name  - The name of the security alert policy.
 - Server
Name string - The name of the server.
 
- database
Name String - The name of the database for which the security alert policy is defined.
 - resource
Group StringName  - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
 - security
Alert StringPolicy Name  - The name of the security alert policy.
 - server
Name String - The name of the server.
 
- database
Name string - The name of the database for which the security alert policy is defined.
 - resource
Group stringName  - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
 - security
Alert stringPolicy Name  - The name of the security alert policy.
 - server
Name string - The name of the server.
 
- database_
name str - The name of the database for which the security alert policy is defined.
 - resource_
group_ strname  - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
 - security_
alert_ strpolicy_ name  - The name of the security alert policy.
 - server_
name str - The name of the server.
 
- database
Name String - The name of the database for which the security alert policy is defined.
 - resource
Group StringName  - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
 - security
Alert StringPolicy Name  - The name of the security alert policy.
 - server
Name String - The name of the server.
 
getDatabaseSecurityAlertPolicy Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Creation
Time string - Specifies the UTC creation time of the policy.
 - Id string
 - Resource ID.
 - Name string
 - Resource name.
 - State string
 - Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
 - System
Data Pulumi.Azure Native. Sql. Outputs. System Data Response  - SystemData of SecurityAlertPolicyResource.
 - Type string
 - Resource type.
 - Disabled
Alerts List<string> - Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
 - Email
Account boolAdmins  - Specifies that the alert is sent to the account administrators.
 - Email
Addresses List<string> - Specifies an array of e-mail addresses to which the alert is sent.
 - Retention
Days int - Specifies the number of days to keep in the Threat Detection audit logs.
 - Storage
Account stringAccess Key  - Specifies the identifier key of the Threat Detection audit storage account.
 - Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Creation
Time string - Specifies the UTC creation time of the policy.
 - Id string
 - Resource ID.
 - Name string
 - Resource name.
 - State string
 - Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
 - System
Data SystemData Response  - SystemData of SecurityAlertPolicyResource.
 - Type string
 - Resource type.
 - Disabled
Alerts []string - Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
 - Email
Account boolAdmins  - Specifies that the alert is sent to the account administrators.
 - Email
Addresses []string - Specifies an array of e-mail addresses to which the alert is sent.
 - Retention
Days int - Specifies the number of days to keep in the Threat Detection audit logs.
 - Storage
Account stringAccess Key  - Specifies the identifier key of the Threat Detection audit storage account.
 - Storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - creation
Time String - Specifies the UTC creation time of the policy.
 - id String
 - Resource ID.
 - name String
 - Resource name.
 - state String
 - Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
 - system
Data SystemData Response  - SystemData of SecurityAlertPolicyResource.
 - type String
 - Resource type.
 - disabled
Alerts List<String> - Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
 - email
Account BooleanAdmins  - Specifies that the alert is sent to the account administrators.
 - email
Addresses List<String> - Specifies an array of e-mail addresses to which the alert is sent.
 - retention
Days Integer - Specifies the number of days to keep in the Threat Detection audit logs.
 - storage
Account StringAccess Key  - Specifies the identifier key of the Threat Detection audit storage account.
 - storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - creation
Time string - Specifies the UTC creation time of the policy.
 - id string
 - Resource ID.
 - name string
 - Resource name.
 - state string
 - Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
 - system
Data SystemData Response  - SystemData of SecurityAlertPolicyResource.
 - type string
 - Resource type.
 - disabled
Alerts string[] - Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
 - email
Account booleanAdmins  - Specifies that the alert is sent to the account administrators.
 - email
Addresses string[] - Specifies an array of e-mail addresses to which the alert is sent.
 - retention
Days number - Specifies the number of days to keep in the Threat Detection audit logs.
 - storage
Account stringAccess Key  - Specifies the identifier key of the Threat Detection audit storage account.
 - storage
Endpoint string - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - creation_
time str - Specifies the UTC creation time of the policy.
 - id str
 - Resource ID.
 - name str
 - Resource name.
 - state str
 - Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
 - system_
data SystemData Response  - SystemData of SecurityAlertPolicyResource.
 - type str
 - Resource type.
 - disabled_
alerts Sequence[str] - Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
 - email_
account_ booladmins  - Specifies that the alert is sent to the account administrators.
 - email_
addresses Sequence[str] - Specifies an array of e-mail addresses to which the alert is sent.
 - retention_
days int - Specifies the number of days to keep in the Threat Detection audit logs.
 - storage_
account_ straccess_ key  - Specifies the identifier key of the Threat Detection audit storage account.
 - storage_
endpoint str - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - creation
Time String - Specifies the UTC creation time of the policy.
 - id String
 - Resource ID.
 - name String
 - Resource name.
 - state String
 - Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
 - system
Data Property Map - SystemData of SecurityAlertPolicyResource.
 - type String
 - Resource type.
 - disabled
Alerts List<String> - Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
 - email
Account BooleanAdmins  - Specifies that the alert is sent to the account administrators.
 - email
Addresses List<String> - Specifies an array of e-mail addresses to which the alert is sent.
 - retention
Days Number - Specifies the number of days to keep in the Threat Detection audit logs.
 - storage
Account StringAccess Key  - Specifies the identifier key of the Threat Detection audit storage account.
 - storage
Endpoint String - Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
 
Supporting Types
SystemDataResponse  
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
- created
At string - The timestamp of resource creation (UTC).
 - created
By string - The identity that created the resource.
 - created
By stringType  - The type of identity that created the resource.
 - last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - last
Modified stringBy  - The identity that last modified the resource.
 - last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created_
at str - The timestamp of resource creation (UTC).
 - created_
by str - The identity that created the resource.
 - created_
by_ strtype  - The type of identity that created the resource.
 - last_
modified_ strat  - The timestamp of resource last modification (UTC)
 - last_
modified_ strby  - The identity that last modified the resource.
 - last_
modified_ strby_ type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0