Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getBackupLongTermRetentionPolicy
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.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getBackupLongTermRetentionPolicy

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.5.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a database’s long term retention policy.

    Uses Azure REST API version 2017-03-01-preview.

    Using getBackupLongTermRetentionPolicy

    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 getBackupLongTermRetentionPolicy(args: GetBackupLongTermRetentionPolicyArgs, opts?: InvokeOptions): Promise<GetBackupLongTermRetentionPolicyResult>
function getBackupLongTermRetentionPolicyOutput(args: GetBackupLongTermRetentionPolicyOutputArgs, opts?: InvokeOptions): Output<GetBackupLongTermRetentionPolicyResult>
    def get_backup_long_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) -> GetBackupLongTermRetentionPolicyResult
def get_backup_long_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[GetBackupLongTermRetentionPolicyResult]
    func LookupBackupLongTermRetentionPolicy(ctx *Context, args *LookupBackupLongTermRetentionPolicyArgs, opts ...InvokeOption) (*LookupBackupLongTermRetentionPolicyResult, error)
func LookupBackupLongTermRetentionPolicyOutput(ctx *Context, args *LookupBackupLongTermRetentionPolicyOutputArgs, opts ...InvokeOption) LookupBackupLongTermRetentionPolicyResultOutput

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

    public static class GetBackupLongTermRetentionPolicy 
{
    public static Task<GetBackupLongTermRetentionPolicyResult> InvokeAsync(GetBackupLongTermRetentionPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupLongTermRetentionPolicyResult> Invoke(GetBackupLongTermRetentionPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupLongTermRetentionPolicyResult> getBackupLongTermRetentionPolicy(GetBackupLongTermRetentionPolicyArgs args, InvokeOptions options)
public static Output<GetBackupLongTermRetentionPolicyResult> getBackupLongTermRetentionPolicy(GetBackupLongTermRetentionPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:sql:getBackupLongTermRetentionPolicy
  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.

    getBackupLongTermRetentionPolicy 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.
    MonthlyRetention string
    The monthly retention policy for an LTR backup in an ISO 8601 format.
    WeekOfYear int
    The week of year to take the yearly backup in an ISO 8601 format.
    WeeklyRetention string
    The weekly retention policy for an LTR backup in an ISO 8601 format.
    YearlyRetention string
    The yearly retention policy for an LTR backup in an ISO 8601 format.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    Name string
    Resource name.
    Type string
    Resource type.
    MonthlyRetention string
    The monthly retention policy for an LTR backup in an ISO 8601 format.
    WeekOfYear int
    The week of year to take the yearly backup in an ISO 8601 format.
    WeeklyRetention string
    The weekly retention policy for an LTR backup in an ISO 8601 format.
    YearlyRetention string
    The yearly retention policy for an LTR backup in an ISO 8601 format.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    type String
    Resource type.
    monthlyRetention String
    The monthly retention policy for an LTR backup in an ISO 8601 format.
    weekOfYear Integer
    The week of year to take the yearly backup in an ISO 8601 format.
    weeklyRetention String
    The weekly retention policy for an LTR backup in an ISO 8601 format.
    yearlyRetention String
    The yearly retention policy for an LTR backup in an ISO 8601 format.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource ID.
    name string
    Resource name.
    type string
    Resource type.
    monthlyRetention string
    The monthly retention policy for an LTR backup in an ISO 8601 format.
    weekOfYear number
    The week of year to take the yearly backup in an ISO 8601 format.
    weeklyRetention string
    The weekly retention policy for an LTR backup in an ISO 8601 format.
    yearlyRetention string
    The yearly retention policy for an LTR backup in an ISO 8601 format.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource ID.
    name str
    Resource name.
    type str
    Resource type.
    monthly_retention str
    The monthly retention policy for an LTR backup in an ISO 8601 format.
    week_of_year int
    The week of year to take the yearly backup in an ISO 8601 format.
    weekly_retention str
    The weekly retention policy for an LTR backup in an ISO 8601 format.
    yearly_retention str
    The yearly retention policy for an LTR backup in an ISO 8601 format.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    name String
    Resource name.
    type String
    Resource type.
    monthlyRetention String
    The monthly retention policy for an LTR backup in an ISO 8601 format.
    weekOfYear Number
    The week of year to take the yearly backup in an ISO 8601 format.
    weeklyRetention String
    The weekly retention policy for an LTR backup in an ISO 8601 format.
    yearlyRetention String
    The yearly retention policy for an LTR backup in an ISO 8601 format.

    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.5.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-azure-native