GremlinDatabaseCollection 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:
GremlinDatabaseCollection.cs
Source:
GremlinDatabaseCollection.cs

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

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

Constructors

GremlinDatabaseCollection()

Initializes a new instance of the GremlinDatabaseCollection 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, GremlinDatabaseCreateOrUpdateContent, CancellationToken)

Create or update an Azure Cosmos DB Gremlin database

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_CreateUpdateGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
CreateOrUpdateAsync(WaitUntil, String, GremlinDatabaseCreateOrUpdateContent, CancellationToken)

Create or update an Azure Cosmos DB Gremlin database

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_CreateUpdateGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
Get(String, CancellationToken)

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
GetAll(CancellationToken)

Lists the Gremlin databases under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases
  • Operation Id: GremlinResources_ListGremlinDatabases
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
GetAllAsync(CancellationToken)

Lists the Gremlin databases under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases
  • Operation Id: GremlinResources_ListGremlinDatabases
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
GetAsync(String, CancellationToken)

Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}
  • Operation Id: GremlinResources_GetGremlinDatabase
  • Default Api Version: 2024-09-01-preview
  • Resource: GremlinDatabaseResource
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<GremlinDatabaseResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.
IEnumerable<GremlinDatabaseResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to