GremlinDatabaseResource.GetGremlinGraphAsync Method

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:: GremlinDatabaseResource.cs

Source:: GremlinDatabaseResource.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.

Gets the Gremlin graph under an existing Azure Cosmos DB database account.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}
Operation Id: GremlinResources_GetGremlinGraph
Default Api Version: 2024-09-01-preview
Resource: GremlinGraphResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.GremlinGraphResource>> GetGremlinGraphAsync (string graphName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetGremlinGraphAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.GremlinGraphResource>>
override this.GetGremlinGraphAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.GremlinGraphResource>>

Public Overridable Function GetGremlinGraphAsync (graphName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of GremlinGraphResource))

Parameters

graphName: String

Cosmos DB graph name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<GremlinGraphResource>>

Exceptions

ArgumentNullException

graphName is null.

ArgumentException

graphName is an empty string, and was expected to be non-empty.

Applies to

Share via