Package version:

Interface BackupShortTermRetentionPolicies

Interface representing a BackupShortTermRetentionPolicies.

Hierarchy

BackupShortTermRetentionPolicies

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginUpdate beginUpdateAndWait get listByDatabase

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>
Updates a database's short 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: BackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>
- Defined in operationsInterfaces/backupShortTermRetentionPolicies.ts:66

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<BackupShortTermRetentionPolicy>
Updates a database's short 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: BackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<BackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/backupShortTermRetentionPolicies.ts:89

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>
Updates a database's short 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: BackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: BackupShortTermRetentionPoliciesUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>
- Defined in operationsInterfaces/backupShortTermRetentionPolicies.ts:107

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesUpdateOptionalParams): Promise<BackupShortTermRetentionPolicy>
Updates a database's short 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: BackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: BackupShortTermRetentionPoliciesUpdateOptionalParams
  
  The options parameters.
Returns Promise<BackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/backupShortTermRetentionPolicies.ts:130

get

get(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, options?: BackupShortTermRetentionPoliciesGetOptionalParams): Promise<BackupShortTermRetentionPolicy>
Gets a database's short 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: BackupShortTermRetentionPoliciesGetOptionalParams
  
  The options parameters.
Returns Promise<BackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/backupShortTermRetentionPolicies.ts:49

listByDatabase

listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: BackupShortTermRetentionPoliciesListByDatabaseOptionalParams): PagedAsyncIterableIterator<BackupShortTermRetentionPolicy>
Gets a database's short 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: BackupShortTermRetentionPoliciesListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<BackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/backupShortTermRetentionPolicies.ts:34

Interface BackupShortTermRetentionPolicies

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

parameters: BackupShortTermRetentionPolicy

Optional options: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

parameters: BackupShortTermRetentionPolicy

Optional options: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<BackupShortTermRetentionPolicy>

beginUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

parameters: BackupShortTermRetentionPolicy

Optional options: BackupShortTermRetentionPoliciesUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

parameters: BackupShortTermRetentionPolicy

Optional options: BackupShortTermRetentionPoliciesUpdateOptionalParams

Returns Promise<BackupShortTermRetentionPolicy>

get

Parameters

resourceGroupName: string

serverName: string

databaseName: string

policyName: string

Optional options: BackupShortTermRetentionPoliciesGetOptionalParams

Returns Promise<BackupShortTermRetentionPolicy>

listByDatabase

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: BackupShortTermRetentionPoliciesListByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<BackupShortTermRetentionPolicy>

Settings

Member Visibility

Theme

`Optional` options: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: BackupShortTermRetentionPoliciesUpdateOptionalParams

`Optional` options: BackupShortTermRetentionPoliciesUpdateOptionalParams

`Optional` options: BackupShortTermRetentionPoliciesGetOptionalParams

`Optional` options: BackupShortTermRetentionPoliciesListByDatabaseOptionalParams