CosmosDBLocationCollection Class

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.11

Source:: CosmosDBLocationCollection.cs

Source:: CosmosDBLocationCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class CosmosDBLocationCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBLocationResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.CosmosDBLocationResource>

type CosmosDBLocationCollection = class
    inherit ArmCollection
    interface seq<CosmosDBLocationResource>
    interface IEnumerable
    interface IAsyncEnumerable<CosmosDBLocationResource>

Public Class CosmosDBLocationCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of CosmosDBLocationResource), IEnumerable(Of CosmosDBLocationResource)

Inheritance: Object

ArmCollection
CosmosDBLocationCollection

Implements: IAsyncEnumerable<CosmosDBLocationResource> IEnumerable<CosmosDBLocationResource> IEnumerable

Constructors

CosmosDBLocationCollection()

Initializes a new instance of the CosmosDBLocationCollection 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(AzureLocation, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location} Operation Id: Locations_Get Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
ExistsAsync(AzureLocation, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location} Operation Id: Locations_Get Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
Get(AzureLocation, CancellationToken)	Get the properties of an existing Cosmos DB location Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location} Operation Id: Locations_Get Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
GetAll(CancellationToken)	List Cosmos DB locations and their properties Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations Operation Id: Locations_List Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
GetAllAsync(CancellationToken)	List Cosmos DB locations and their properties Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations Operation Id: Locations_List Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
GetAsync(AzureLocation, CancellationToken)	Get the properties of an existing Cosmos DB location Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location} Operation Id: Locations_Get Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
GetIfExists(AzureLocation, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location} Operation Id: Locations_Get Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
GetIfExistsAsync(AzureLocation, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location} Operation Id: Locations_Get Default Api Version: 2024-09-01-preview Resource: CosmosDBLocationResource
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<CosmosDBLocationResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<CosmosDBLocationResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.

Applies to

Sdílet prostřednictvím