1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getDatabaseSecurityAlertPolicy
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.75.0 published on Saturday, Nov 30, 2024 by Pulumi

azure-native.sql.getDatabaseSecurityAlertPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.75.0 published on Saturday, Nov 30, 2024 by Pulumi

    Gets a database’s security alert policy. Azure REST API version: 2021-11-01.

    Other available API versions: 2018-06-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:sql:getDatabaseSecurityAlertPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    The name of the database for which the security alert policy is defined.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    SecurityAlertPolicyName string
    The name of the security alert policy.
    ServerName string
    The name of the server.
    DatabaseName string
    The name of the database for which the security alert policy is defined.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    SecurityAlertPolicyName string
    The name of the security alert policy.
    ServerName string
    The name of the server.
    databaseName String
    The name of the database for which the security alert policy is defined.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    securityAlertPolicyName String
    The name of the security alert policy.
    serverName String
    The name of the server.
    databaseName string
    The name of the database for which the security alert policy is defined.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    securityAlertPolicyName string
    The name of the security alert policy.
    serverName string
    The name of the server.
    database_name str
    The name of the database for which the security alert policy is defined.
    resource_group_name str
    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_policy_name str
    The name of the security alert policy.
    server_name str
    The name of the server.
    databaseName String
    The name of the database for which the security alert policy is defined.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    securityAlertPolicyName String
    The name of the security alert policy.
    serverName String
    The name of the server.

    getDatabaseSecurityAlertPolicy Result

    The following output properties are available:

    CreationTime 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.
    SystemData Pulumi.AzureNative.Sql.Outputs.SystemDataResponse
    SystemData of SecurityAlertPolicyResource.
    Type string
    Resource type.
    DisabledAlerts 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
    EmailAccountAdmins bool
    Specifies that the alert is sent to the account administrators.
    EmailAddresses List<string>
    Specifies an array of e-mail addresses to which the alert is sent.
    RetentionDays int
    Specifies the number of days to keep in the Threat Detection audit logs.
    StorageAccountAccessKey string
    Specifies the identifier key of the Threat Detection audit storage account.
    StorageEndpoint string
    Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    CreationTime 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.
    SystemData SystemDataResponse
    SystemData of SecurityAlertPolicyResource.
    Type string
    Resource type.
    DisabledAlerts []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
    EmailAccountAdmins bool
    Specifies that the alert is sent to the account administrators.
    EmailAddresses []string
    Specifies an array of e-mail addresses to which the alert is sent.
    RetentionDays int
    Specifies the number of days to keep in the Threat Detection audit logs.
    StorageAccountAccessKey string
    Specifies the identifier key of the Threat Detection audit storage account.
    StorageEndpoint string
    Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    creationTime 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.
    systemData SystemDataResponse
    SystemData of SecurityAlertPolicyResource.
    type String
    Resource type.
    disabledAlerts 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
    emailAccountAdmins Boolean
    Specifies that the alert is sent to the account administrators.
    emailAddresses List<String>
    Specifies an array of e-mail addresses to which the alert is sent.
    retentionDays Integer
    Specifies the number of days to keep in the Threat Detection audit logs.
    storageAccountAccessKey String
    Specifies the identifier key of the Threat Detection audit storage account.
    storageEndpoint String
    Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    creationTime 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.
    systemData SystemDataResponse
    SystemData of SecurityAlertPolicyResource.
    type string
    Resource type.
    disabledAlerts 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
    emailAccountAdmins boolean
    Specifies that the alert is sent to the account administrators.
    emailAddresses string[]
    Specifies an array of e-mail addresses to which the alert is sent.
    retentionDays number
    Specifies the number of days to keep in the Threat Detection audit logs.
    storageAccountAccessKey string
    Specifies the identifier key of the Threat Detection audit storage account.
    storageEndpoint string
    Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    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 SystemDataResponse
    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_admins bool
    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_access_key str
    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.
    creationTime 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.
    systemData Property Map
    SystemData of SecurityAlertPolicyResource.
    type String
    Resource type.
    disabledAlerts 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
    emailAccountAdmins Boolean
    Specifies that the alert is sent to the account administrators.
    emailAddresses List<String>
    Specifies an array of e-mail addresses to which the alert is sent.
    retentionDays Number
    Specifies the number of days to keep in the Threat Detection audit logs.
    storageAccountAccessKey String
    Specifies the identifier key of the Threat Detection audit storage account.
    storageEndpoint 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

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.75.0 published on Saturday, Nov 30, 2024 by Pulumi