Share via


LongTermRetentionPolicyCollection Class

Definition

A class representing a collection of LongTermRetentionPolicyResource and their operations. Each LongTermRetentionPolicyResource in the collection will belong to the same instance of SqlDatabaseResource. To get a LongTermRetentionPolicyCollection instance call the GetLongTermRetentionPolicies method from an instance of SqlDatabaseResource.

public class LongTermRetentionPolicyCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Sql.LongTermRetentionPolicyResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Sql.LongTermRetentionPolicyResource>
type LongTermRetentionPolicyCollection = class
    inherit ArmCollection
    interface seq<LongTermRetentionPolicyResource>
    interface IEnumerable
    interface IAsyncEnumerable<LongTermRetentionPolicyResource>
Public Class LongTermRetentionPolicyCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of LongTermRetentionPolicyResource), IEnumerable(Of LongTermRetentionPolicyResource)
Inheritance
LongTermRetentionPolicyCollection
Implements

Constructors

LongTermRetentionPolicyCollection()

Initializes a new instance of the LongTermRetentionPolicyCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, LongTermRetentionPolicyName, LongTermRetentionPolicyData, CancellationToken)

Set or update a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_CreateOrUpdate
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
CreateOrUpdateAsync(WaitUntil, LongTermRetentionPolicyName, LongTermRetentionPolicyData, CancellationToken)

Set or update a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_CreateOrUpdate
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
Exists(LongTermRetentionPolicyName, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
ExistsAsync(LongTermRetentionPolicyName, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
Get(LongTermRetentionPolicyName, CancellationToken)

Gets a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
GetAll(CancellationToken)

Gets a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies
  • Operation Id: LongTermRetentionPolicies_ListByDatabase
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
GetAllAsync(CancellationToken)

Gets a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies
  • Operation Id: LongTermRetentionPolicies_ListByDatabase
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
GetAsync(LongTermRetentionPolicyName, CancellationToken)

Gets a database's long term retention policy.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
GetIfExists(LongTermRetentionPolicyName, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
GetIfExistsAsync(LongTermRetentionPolicyName, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}
  • Operation Id: LongTermRetentionPolicies_Get
  • Default Api Version: 2023-05-01-preview
  • Resource: LongTermRetentionPolicyResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<LongTermRetentionPolicyResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<LongTermRetentionPolicyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to