Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. getBackupLongTermRetentionPolicy
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.sql.getBackupLongTermRetentionPolicy

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a database’s long term retention policy. 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>
Copy
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]
Copy
func LookupBackupLongTermRetentionPolicy(ctx *Context, args *LookupBackupLongTermRetentionPolicyArgs, opts ...InvokeOption) (*LookupBackupLongTermRetentionPolicyResult, error)
func LookupBackupLongTermRetentionPolicyOutput(ctx *Context, args *LookupBackupLongTermRetentionPolicyOutputArgs, opts ...InvokeOption) LookupBackupLongTermRetentionPolicyResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetBackupLongTermRetentionPolicyResult> getBackupLongTermRetentionPolicy(GetBackupLongTermRetentionPolicyArgs args, InvokeOptions options)
public static Output<GetBackupLongTermRetentionPolicyResult> getBackupLongTermRetentionPolicy(GetBackupLongTermRetentionPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getBackupLongTermRetentionPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
PolicyName
This property is required.
Changes to this property will trigger replacement.
string
The policy name. Should always be Default.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
PolicyName
This property is required.
Changes to this property will trigger replacement.
string
The policy name. Should always be Default.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
policyName
This property is required.
Changes to this property will trigger replacement.
String
The policy name. Should always be Default.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
policyName
This property is required.
Changes to this property will trigger replacement.
string
The policy name. Should always be Default.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database.
policy_name
This property is required.
Changes to this property will trigger replacement.
str
The policy name. Should always be Default.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
policyName
This property is required.
Changes to this property will trigger replacement.
String
The policy name. Should always be Default.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.

getBackupLongTermRetentionPolicy Result

The following output properties are available:

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.
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.
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.
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.
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.
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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native