Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getBackupShortTermRetentionPolicy
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getBackupShortTermRetentionPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a database’s short term retention policy.

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2017-10-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 getBackupShortTermRetentionPolicy

    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 getBackupShortTermRetentionPolicy(args: GetBackupShortTermRetentionPolicyArgs, opts?: InvokeOptions): Promise<GetBackupShortTermRetentionPolicyResult>
function getBackupShortTermRetentionPolicyOutput(args: GetBackupShortTermRetentionPolicyOutputArgs, opts?: InvokeOptions): Output<GetBackupShortTermRetentionPolicyResult>
    def get_backup_short_term_retention_policy(database_name: Optional[str] = None,
                                           policy_name: Optional[str] = None,
                                           resource_group_name: Optional[str] = None,
                                           server_name: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetBackupShortTermRetentionPolicyResult
def get_backup_short_term_retention_policy_output(database_name: Optional[pulumi.Input[str]] = None,
                                           policy_name: Optional[pulumi.Input[str]] = None,
                                           resource_group_name: Optional[pulumi.Input[str]] = None,
                                           server_name: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetBackupShortTermRetentionPolicyResult]
    func LookupBackupShortTermRetentionPolicy(ctx *Context, args *LookupBackupShortTermRetentionPolicyArgs, opts ...InvokeOption) (*LookupBackupShortTermRetentionPolicyResult, error)
func LookupBackupShortTermRetentionPolicyOutput(ctx *Context, args *LookupBackupShortTermRetentionPolicyOutputArgs, opts ...InvokeOption) LookupBackupShortTermRetentionPolicyResultOutput

    > Note: This function is named LookupBackupShortTermRetentionPolicy in the Go SDK.

    public static class GetBackupShortTermRetentionPolicy 
{
    public static Task<GetBackupShortTermRetentionPolicyResult> InvokeAsync(GetBackupShortTermRetentionPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupShortTermRetentionPolicyResult> Invoke(GetBackupShortTermRetentionPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupShortTermRetentionPolicyResult> getBackupShortTermRetentionPolicy(GetBackupShortTermRetentionPolicyArgs args, InvokeOptions options)
public static Output<GetBackupShortTermRetentionPolicyResult> getBackupShortTermRetentionPolicy(GetBackupShortTermRetentionPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:sql:getBackupShortTermRetentionPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    The name of the database.
    PolicyName string
    The policy name. Should always be "default".
    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.
    ServerName string
    The name of the server.
    DatabaseName string
    The name of the database.
    PolicyName string
    The policy name. Should always be "default".
    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.
    ServerName string
    The name of the server.
    databaseName String
    The name of the database.
    policyName String
    The policy name. Should always be "default".
    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.
    serverName String
    The name of the server.
    databaseName string
    The name of the database.
    policyName string
    The policy name. Should always be "default".
    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.
    serverName string
    The name of the server.
    database_name str
    The name of the database.
    policy_name str
    The policy name. Should always be "default".
    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.
    server_name str
    The name of the server.
    databaseName String
    The name of the database.
    policyName String
    The policy name. Should always be "default".
    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.
    serverName String
    The name of the server.

    getBackupShortTermRetentionPolicy Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Name string
    Resource name.
    Type string
    Resource type.
    DiffBackupIntervalInHours int
    The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
    RetentionDays int
    The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Name string
    Resource name.
    Type string
    Resource type.
    DiffBackupIntervalInHours int
    The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
    RetentionDays int
    The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    type String
    Resource type.
    diffBackupIntervalInHours Integer
    The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
    retentionDays Integer
    The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource ID.
    name string
    Resource name.
    type string
    Resource type.
    diffBackupIntervalInHours number
    The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
    retentionDays number
    The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource ID.
    name str
    Resource name.
    type str
    Resource type.
    diff_backup_interval_in_hours int
    The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
    retention_days int
    The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    type String
    Resource type.
    diffBackupIntervalInHours Number
    The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
    retentionDays Number
    The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native