LongTermRetentionPolicies interface

Interface representing a LongTermRetentionPolicies.

Methods

beginCreateOrUpdate(string, string, string, string, LongTermRetentionPolicy, LongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a database's long term retention policy.

beginCreateOrUpdateAndWait(string, string, string, string, LongTermRetentionPolicy, LongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a database's long term retention policy.

get(string, string, string, string, LongTermRetentionPoliciesGetOptionalParams)

Gets a database's long term retention policy.

listByDatabase(string, string, string, LongTermRetentionPoliciesListByDatabaseOptionalParams)

Gets a database's long term retention policy.

Method Details

beginCreateOrUpdate(string, string, string, string, LongTermRetentionPolicy, LongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a database's long term retention policy.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: LongTermRetentionPolicy, options?: LongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LongTermRetentionPolicy>, LongTermRetentionPolicy>>

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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

policyName

string

The policy name. Should always be Default.

parameters
LongTermRetentionPolicy

The long term retention policy info.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, string, LongTermRetentionPolicy, LongTermRetentionPoliciesCreateOrUpdateOptionalParams)

Sets a database's long term retention policy.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: LongTermRetentionPolicy, options?: LongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<LongTermRetentionPolicy>

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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

policyName

string

The policy name. Should always be Default.

parameters
LongTermRetentionPolicy

The long term retention policy info.

Returns

get(string, string, string, string, LongTermRetentionPoliciesGetOptionalParams)

Gets a database's long term retention policy.

function get(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, options?: LongTermRetentionPoliciesGetOptionalParams): Promise<LongTermRetentionPolicy>

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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

policyName

string

The policy name. Should always be Default.

options
LongTermRetentionPoliciesGetOptionalParams

The options parameters.

Returns

listByDatabase(string, string, string, LongTermRetentionPoliciesListByDatabaseOptionalParams)

Gets a database's long term retention policy.

function listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: LongTermRetentionPoliciesListByDatabaseOptionalParams): PagedAsyncIterableIterator<LongTermRetentionPolicy, LongTermRetentionPolicy[], 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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

Returns