CosmosDBServiceCollection Class

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

CosmosDBServiceCollection.cs

A class representing a collection of CosmosDBServiceResource and their operations. Each CosmosDBServiceResource in the collection will belong to the same instance of CosmosDBAccountResource. To get a CosmosDBServiceCollection instance call the GetCosmosDBServices method from an instance of CosmosDBAccountResource.

C#

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

Inheritance

Object

ArmCollection

CosmosDBServiceCollection

Implements

IAsyncEnumerable<CosmosDBServiceResource> IEnumerable<CosmosDBServiceResource> IEnumerable

Constructors

CosmosDBServiceCollection()

Initializes a new instance of the CosmosDBServiceCollection 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, String, CosmosDBServiceCreateOrUpdateContent, CancellationToken)	Creates a service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Create Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
CreateOrUpdateAsync(WaitUntil, String, CosmosDBServiceCreateOrUpdateContent, CancellationToken)	Creates a service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Create Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Get Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Get Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
Get(String, CancellationToken)	Gets the status of service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Get Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
GetAll(CancellationToken)	Gets the status of service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services Operation Id: Service_List Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
GetAllAsync(CancellationToken)	Gets the status of service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services Operation Id: Service_List Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
GetAsync(String, CancellationToken)	Gets the status of service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Get Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Get Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName} Operation Id: Service_Get Default Api Version: 2024-12-01-preview Resource: CosmosDBServiceResource
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<CosmosDBServiceResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<CosmosDBServiceResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.

Applies to