Package version:

Interface LongTermRetentionPolicies

Interface representing a LongTermRetentionPolicies.

Hierarchy

LongTermRetentionPolicies

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait get listByDatabase

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: LongTermRetentionPolicy, options?: LongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LongTermRetentionPolicy>, LongTermRetentionPolicy>>
Sets a database's long term retention policy.
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.
- Optional options: LongTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<LongTermRetentionPolicy>, LongTermRetentionPolicy>>
- Defined in operationsInterfaces/longTermRetentionPolicies.ts:64

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: LongTermRetentionPolicy, options?: LongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<LongTermRetentionPolicy>
Sets a database's long term retention policy.
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.
- Optional options: LongTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionPolicy>
- Defined in operationsInterfaces/longTermRetentionPolicies.ts:87

get

get(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, options?: LongTermRetentionPoliciesGetOptionalParams): Promise<LongTermRetentionPolicy>
Gets a database's long term retention policy.
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.
- Optional options: LongTermRetentionPoliciesGetOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionPolicy>
- Defined in operationsInterfaces/longTermRetentionPolicies.ts:47

listByDatabase

listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: LongTermRetentionPoliciesListByDatabaseOptionalParams): PagedAsyncIterableIterator<LongTermRetentionPolicy>
Gets a database's long term retention policy.
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.
- Optional options: LongTermRetentionPoliciesListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LongTermRetentionPolicy>
- Defined in operationsInterfaces/longTermRetentionPolicies.ts:32

Interface LongTermRetentionPolicies

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

parameters: LongTermRetentionPolicy

Optional options: LongTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<LongTermRetentionPolicy>, LongTermRetentionPolicy>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

parameters: LongTermRetentionPolicy

Optional options: LongTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<LongTermRetentionPolicy>

get

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

Optional options: LongTermRetentionPoliciesGetOptionalParams

Returns Promise<LongTermRetentionPolicy>

listByDatabase

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: LongTermRetentionPoliciesListByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<LongTermRetentionPolicy>

Settings

Member Visibility

Theme

`Optional` options: LongTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: LongTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: LongTermRetentionPoliciesGetOptionalParams

`Optional` options: LongTermRetentionPoliciesListByDatabaseOptionalParams