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

azure-native.sql.getManagedInstanceLongTermRetentionPolicy

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a managed database’s long term retention policy.

Uses Azure REST API version 2023-08-01.

Other available API versions: 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 getManagedInstanceLongTermRetentionPolicy

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 getManagedInstanceLongTermRetentionPolicy(args: GetManagedInstanceLongTermRetentionPolicyArgs, opts?: InvokeOptions): Promise<GetManagedInstanceLongTermRetentionPolicyResult>
function getManagedInstanceLongTermRetentionPolicyOutput(args: GetManagedInstanceLongTermRetentionPolicyOutputArgs, opts?: InvokeOptions): Output<GetManagedInstanceLongTermRetentionPolicyResult>
Copy
def get_managed_instance_long_term_retention_policy(database_name: Optional[str] = None,
                                                    managed_instance_name: Optional[str] = None,
                                                    policy_name: Optional[str] = None,
                                                    resource_group_name: Optional[str] = None,
                                                    opts: Optional[InvokeOptions] = None) -> GetManagedInstanceLongTermRetentionPolicyResult
def get_managed_instance_long_term_retention_policy_output(database_name: Optional[pulumi.Input[str]] = None,
                                                    managed_instance_name: Optional[pulumi.Input[str]] = None,
                                                    policy_name: Optional[pulumi.Input[str]] = None,
                                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                                    opts: Optional[InvokeOptions] = None) -> Output[GetManagedInstanceLongTermRetentionPolicyResult]
Copy
func LookupManagedInstanceLongTermRetentionPolicy(ctx *Context, args *LookupManagedInstanceLongTermRetentionPolicyArgs, opts ...InvokeOption) (*LookupManagedInstanceLongTermRetentionPolicyResult, error)
func LookupManagedInstanceLongTermRetentionPolicyOutput(ctx *Context, args *LookupManagedInstanceLongTermRetentionPolicyOutputArgs, opts ...InvokeOption) LookupManagedInstanceLongTermRetentionPolicyResultOutput
Copy

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

public static class GetManagedInstanceLongTermRetentionPolicy 
{
    public static Task<GetManagedInstanceLongTermRetentionPolicyResult> InvokeAsync(GetManagedInstanceLongTermRetentionPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetManagedInstanceLongTermRetentionPolicyResult> Invoke(GetManagedInstanceLongTermRetentionPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagedInstanceLongTermRetentionPolicyResult> getManagedInstanceLongTermRetentionPolicy(GetManagedInstanceLongTermRetentionPolicyArgs args, InvokeOptions options)
public static Output<GetManagedInstanceLongTermRetentionPolicyResult> getManagedInstanceLongTermRetentionPolicy(GetManagedInstanceLongTermRetentionPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getManagedInstanceLongTermRetentionPolicy
  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.
ManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
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.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ManagedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
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.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed instance.
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.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed instance.
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.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database.
managed_instance_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the managed instance.
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.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
managedInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed instance.
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.

getManagedInstanceLongTermRetentionPolicy 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.
BackupStorageAccessTier string
The BackupStorageAccessTier for the LTR backups
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.
BackupStorageAccessTier string
The BackupStorageAccessTier for the LTR backups
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.
backupStorageAccessTier String
The BackupStorageAccessTier for the LTR backups
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.
backupStorageAccessTier string
The BackupStorageAccessTier for the LTR backups
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.
backup_storage_access_tier str
The BackupStorageAccessTier for the LTR backups
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.
backupStorageAccessTier String
The BackupStorageAccessTier for the LTR backups
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
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native