Share via

ManagedInstanceLongTermRetentionPolicies interface

Package:
@azure/arm-sql

Interface representing a ManagedInstanceLongTermRetentionPolicies.

Methods

beginCreateOrUpdate(string, string, string, string, ManagedInstanceLongTermRetentionPolicy, ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a managed database's long term retention policy.
beginCreateOrUpdateAndWait(string, string, string, string, ManagedInstanceLongTermRetentionPolicy, ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a managed database's long term retention policy.
get(string, string, string, string, ManagedInstanceLongTermRetentionPoliciesGetOptionalParams)

Gets a managed database's long term retention policy.
listByDatabase(string, string, string, ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams)

Gets a database's long term retention policy.

Method Details

beginCreateOrUpdate(string, string, string, string, ManagedInstanceLongTermRetentionPolicy, ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a managed database's long term retention policy.

function beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedInstanceLongTermRetentionPolicy, options?: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstanceLongTermRetentionPolicy>, ManagedInstanceLongTermRetentionPolicy>>

Parameters

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.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the database.

policyName

string

The policy name. Should always be Default.

parameters
ManagedInstanceLongTermRetentionPolicy

The long term retention policy info.

options
ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedInstanceLongTermRetentionPolicy>, ManagedInstanceLongTermRetentionPolicy>>

beginCreateOrUpdateAndWait(string, string, string, string, ManagedInstanceLongTermRetentionPolicy, ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a managed database's long term retention policy.

function beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedInstanceLongTermRetentionPolicy, options?: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<ManagedInstanceLongTermRetentionPolicy>

Parameters

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.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the database.

policyName

string

The policy name. Should always be Default.

parameters
ManagedInstanceLongTermRetentionPolicy

The long term retention policy info.

options
ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceLongTermRetentionPolicy>

get(string, string, string, string, ManagedInstanceLongTermRetentionPoliciesGetOptionalParams)

Gets a managed database's long term retention policy.

function get(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, options?: ManagedInstanceLongTermRetentionPoliciesGetOptionalParams): Promise<ManagedInstanceLongTermRetentionPolicy>

Parameters

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.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the database.

policyName

string

The policy name. Should always be Default.

options
ManagedInstanceLongTermRetentionPoliciesGetOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceLongTermRetentionPolicy>

listByDatabase(string, string, string, ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams)

Gets a database's long term retention policy.

function listByDatabase(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionPolicy, ManagedInstanceLongTermRetentionPolicy[], PageSettings>

Parameters

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.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the database.

options
ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionPolicy, ManagedInstanceLongTermRetentionPolicy[], PageSettings>