Class GremlinResourcesOperationsExtensions

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Extension methods for GremlinResourcesOperations.

public static class GremlinResourcesOperationsExtensions

Inheritance

object

GremlinResourcesOperationsExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

BeginCreateUpdateGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, GremlinDatabaseCreateUpdateParameters, CancellationToken)

Create or update an Azure Cosmos DB Gremlin database

public static Task<GremlinDatabaseGetResultsInner> BeginCreateUpdateGremlinDatabaseAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, GremlinDatabaseCreateUpdateParameters createUpdateGremlinDatabaseParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters

The parameters to provide for the current Gremlin database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<GremlinDatabaseGetResultsInner>

BeginCreateUpdateGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, GremlinGraphCreateUpdateParameters, CancellationToken)

Create or update an Azure Cosmos DB Gremlin graph

public static Task<GremlinGraphGetResultsInner> BeginCreateUpdateGremlinGraphAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, GremlinGraphCreateUpdateParameters createUpdateGremlinGraphParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

createUpdateGremlinGraphParameters GremlinGraphCreateUpdateParameters

The parameters to provide for the current Gremlin graph.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<GremlinGraphGetResultsInner>

BeginDeleteGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin database.

public static Task BeginDeleteGremlinDatabaseAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginDeleteGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin graph.

public static Task BeginDeleteGremlinGraphAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginUpdateGremlinDatabaseThroughputAsync(IGremlinResourcesOperations, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin database

public static Task<ThroughputSettingsGetResultsInner> BeginUpdateGremlinDatabaseThroughputAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Gremlin database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

BeginUpdateGremlinGraphThroughputAsync(IGremlinResourcesOperations, string, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin graph

public static Task<ThroughputSettingsGetResultsInner> BeginUpdateGremlinGraphThroughputAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Gremlin graph.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

CreateUpdateGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, GremlinDatabaseCreateUpdateParameters, CancellationToken)

Create or update an Azure Cosmos DB Gremlin database

public static Task<GremlinDatabaseGetResultsInner> CreateUpdateGremlinDatabaseAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, GremlinDatabaseCreateUpdateParameters createUpdateGremlinDatabaseParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters

The parameters to provide for the current Gremlin database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<GremlinDatabaseGetResultsInner>

CreateUpdateGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, GremlinGraphCreateUpdateParameters, CancellationToken)

Create or update an Azure Cosmos DB Gremlin graph

public static Task<GremlinGraphGetResultsInner> CreateUpdateGremlinGraphAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, GremlinGraphCreateUpdateParameters createUpdateGremlinGraphParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

createUpdateGremlinGraphParameters GremlinGraphCreateUpdateParameters

The parameters to provide for the current Gremlin graph.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<GremlinGraphGetResultsInner>

DeleteGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin database.

public static Task DeleteGremlinDatabaseAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

DeleteGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin graph.

public static Task DeleteGremlinGraphAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

GetGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

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

public static Task<GremlinDatabaseGetResultsInner> GetGremlinDatabaseAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<GremlinDatabaseGetResultsInner>

GetGremlinDatabaseThroughputAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.

public static Task<ThroughputSettingsGetResultsInner> GetGremlinDatabaseThroughputAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

GetGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

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

public static Task<GremlinGraphGetResultsInner> GetGremlinGraphAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<GremlinGraphGetResultsInner>

GetGremlinGraphThroughputAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

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

public static Task<ThroughputSettingsGetResultsInner> GetGremlinGraphThroughputAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

ListGremlinDatabasesAsync(IGremlinResourcesOperations, string, string, CancellationToken)

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

public static Task<IEnumerable<GremlinDatabaseGetResultsInner>> ListGremlinDatabasesAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<GremlinDatabaseGetResultsInner>>

ListGremlinGraphsAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

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

public static Task<IEnumerable<GremlinGraphGetResultsInner>> ListGremlinGraphsAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<GremlinGraphGetResultsInner>>

UpdateGremlinDatabaseThroughputAsync(IGremlinResourcesOperations, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin database

public static Task<ThroughputSettingsGetResultsInner> UpdateGremlinDatabaseThroughputAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Gremlin database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

UpdateGremlinGraphThroughputAsync(IGremlinResourcesOperations, string, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin graph

public static Task<ThroughputSettingsGetResultsInner> UpdateGremlinGraphThroughputAsync(this IGremlinResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string graphName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IGremlinResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current Gremlin graph.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>