RestorableCosmosDBAccountCollection Class

Definition

A class representing a collection of RestorableCosmosDBAccountResource and their operations. Each RestorableCosmosDBAccountResource in the collection will belong to the same instance of CosmosDBLocationResource. To get a RestorableCosmosDBAccountCollection instance call the GetRestorableCosmosDBAccounts method from an instance of CosmosDBLocationResource.

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

Constructors

RestorableCosmosDBAccountCollection()

Initializes a new instance of the RestorableCosmosDBAccountCollection 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

Exists(Guid, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}
  • Operation Id: RestorableDatabaseAccounts_GetByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
ExistsAsync(Guid, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}
  • Operation Id: RestorableDatabaseAccounts_GetByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
Get(Guid, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}
  • Operation Id: RestorableDatabaseAccounts_GetByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
GetAll(CancellationToken)

Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts
  • Operation Id: RestorableDatabaseAccounts_ListByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
GetAllAsync(CancellationToken)

Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts
  • Operation Id: RestorableDatabaseAccounts_ListByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
GetAsync(Guid, CancellationToken)

Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}
  • Operation Id: RestorableDatabaseAccounts_GetByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
GetIfExists(Guid, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}
  • Operation Id: RestorableDatabaseAccounts_GetByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
GetIfExistsAsync(Guid, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}
  • Operation Id: RestorableDatabaseAccounts_GetByLocation
  • Default Api Version: 2024-05-15-preview
  • Resource: RestorableCosmosDBAccountResource
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<RestorableCosmosDBAccountResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<RestorableCosmosDBAccountResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to