Package version:

Interface ManagedInstanceLongTermRetentionPolicies

Interface representing a ManagedInstanceLongTermRetentionPolicies.

Hierarchy

ManagedInstanceLongTermRetentionPolicies

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait get listByDatabase

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedInstanceLongTermRetentionPolicy, options?: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstanceLongTermRetentionPolicy>, ManagedInstanceLongTermRetentionPolicy>>
Sets a managed 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.
- 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.
- Optional options: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedInstanceLongTermRetentionPolicy>, ManagedInstanceLongTermRetentionPolicy>>
- Defined in operationsInterfaces/managedInstanceLongTermRetentionPolicies.ts:64

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedInstanceLongTermRetentionPolicy, options?: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<ManagedInstanceLongTermRetentionPolicy>
Sets a managed 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.
- 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.
- Optional options: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstanceLongTermRetentionPolicy>
- Defined in operationsInterfaces/managedInstanceLongTermRetentionPolicies.ts:89

get

get(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, options?: ManagedInstanceLongTermRetentionPoliciesGetOptionalParams): Promise<ManagedInstanceLongTermRetentionPolicy>
Gets a managed 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- policyName: string
  
  The policy name. Should always be Default.
- Optional options: ManagedInstanceLongTermRetentionPoliciesGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstanceLongTermRetentionPolicy>
- Defined in operationsInterfaces/managedInstanceLongTermRetentionPolicies.ts:47

listByDatabase

listByDatabase(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionPolicy>
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- Optional options: ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionPolicy>
- Defined in operationsInterfaces/managedInstanceLongTermRetentionPolicies.ts:32

Interface ManagedInstanceLongTermRetentionPolicies

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

parameters: ManagedInstanceLongTermRetentionPolicy

Optional options: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ManagedInstanceLongTermRetentionPolicy>, ManagedInstanceLongTermRetentionPolicy>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

parameters: ManagedInstanceLongTermRetentionPolicy

Optional options: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<ManagedInstanceLongTermRetentionPolicy>

get

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

Optional options: ManagedInstanceLongTermRetentionPoliciesGetOptionalParams

Returns Promise<ManagedInstanceLongTermRetentionPolicy>

listByDatabase

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

Optional options: ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionPolicy>

Settings

Member Visibility

Theme

`Optional` options: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: ManagedInstanceLongTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: ManagedInstanceLongTermRetentionPoliciesGetOptionalParams

`Optional` options: ManagedInstanceLongTermRetentionPoliciesListByDatabaseOptionalParams