GremlinResources interface

Package:

@azure/arm-cosmosdb

Interface representing a GremlinResources.

Methods

beginCreateUpdateGremlinDatabase(string, string, string, GremlinDatabaseCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams)	Create or update an Azure Cosmos DB Gremlin database
beginCreateUpdateGremlinDatabaseAndWait(string, string, string, GremlinDatabaseCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams)	Create or update an Azure Cosmos DB Gremlin database
beginCreateUpdateGremlinGraph(string, string, string, string, GremlinGraphCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinGraphOptionalParams)	Create or update an Azure Cosmos DB Gremlin graph
beginCreateUpdateGremlinGraphAndWait(string, string, string, string, GremlinGraphCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinGraphOptionalParams)	Create or update an Azure Cosmos DB Gremlin graph
beginDeleteGremlinDatabase(string, string, string, GremlinResourcesDeleteGremlinDatabaseOptionalParams)	Deletes an existing Azure Cosmos DB Gremlin database.
beginDeleteGremlinDatabaseAndWait(string, string, string, GremlinResourcesDeleteGremlinDatabaseOptionalParams)	Deletes an existing Azure Cosmos DB Gremlin database.
beginDeleteGremlinGraph(string, string, string, string, GremlinResourcesDeleteGremlinGraphOptionalParams)	Deletes an existing Azure Cosmos DB Gremlin graph.
beginDeleteGremlinGraphAndWait(string, string, string, string, GremlinResourcesDeleteGremlinGraphOptionalParams)	Deletes an existing Azure Cosmos DB Gremlin graph.
beginMigrateGremlinDatabaseToAutoscale(string, string, string, GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale
beginMigrateGremlinDatabaseToAutoscaleAndWait(string, string, string, GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale
beginMigrateGremlinDatabaseToManualThroughput(string, string, string, GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput
beginMigrateGremlinDatabaseToManualThroughputAndWait(string, string, string, GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput
beginMigrateGremlinGraphToAutoscale(string, string, string, string, GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale
beginMigrateGremlinGraphToAutoscaleAndWait(string, string, string, string, GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams)	Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale
beginMigrateGremlinGraphToManualThroughput(string, string, string, string, GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput
beginMigrateGremlinGraphToManualThroughputAndWait(string, string, string, string, GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams)	Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput
beginRetrieveContinuousBackupInformation(string, string, string, string, ContinuousBackupRestoreLocation, GremlinResourcesRetrieveContinuousBackupInformationOptionalParams)	Retrieves continuous backup information for a gremlin graph.
beginRetrieveContinuousBackupInformationAndWait(string, string, string, string, ContinuousBackupRestoreLocation, GremlinResourcesRetrieveContinuousBackupInformationOptionalParams)	Retrieves continuous backup information for a gremlin graph.
beginUpdateGremlinDatabaseThroughput(string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB Gremlin database
beginUpdateGremlinDatabaseThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB Gremlin database
beginUpdateGremlinGraphThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinGraphThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB Gremlin graph
beginUpdateGremlinGraphThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinGraphThroughputOptionalParams)	Update RUs per second of an Azure Cosmos DB Gremlin graph
getGremlinDatabase(string, string, string, GremlinResourcesGetGremlinDatabaseOptionalParams)	Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
getGremlinDatabaseThroughput(string, string, string, GremlinResourcesGetGremlinDatabaseThroughputOptionalParams)	Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
getGremlinGraph(string, string, string, string, GremlinResourcesGetGremlinGraphOptionalParams)	Gets the Gremlin graph under an existing Azure Cosmos DB database account.
getGremlinGraphThroughput(string, string, string, string, GremlinResourcesGetGremlinGraphThroughputOptionalParams)	Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
listGremlinDatabases(string, string, GremlinResourcesListGremlinDatabasesOptionalParams)	Lists the Gremlin databases under an existing Azure Cosmos DB database account.
listGremlinGraphs(string, string, string, GremlinResourcesListGremlinGraphsOptionalParams)	Lists the Gremlin graph under an existing Azure Cosmos DB database account.

Method Details

beginCreateUpdateGremlinDatabase(string, string, string, GremlinDatabaseCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams)

Create or update an Azure Cosmos DB Gremlin database

function beginCreateUpdateGremlinDatabase(resourceGroupName: string, accountName: string, databaseName: string, createUpdateGremlinDatabaseParameters: GremlinDatabaseCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<GremlinDatabaseGetResults>, GremlinDatabaseGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

createUpdateGremlinDatabaseParameters

GremlinDatabaseCreateUpdateParameters

The parameters to provide for the current Gremlin database.

options

GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GremlinDatabaseGetResults>, GremlinDatabaseGetResults>>

beginCreateUpdateGremlinDatabaseAndWait(string, string, string, GremlinDatabaseCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams)

Create or update an Azure Cosmos DB Gremlin database

function beginCreateUpdateGremlinDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, createUpdateGremlinDatabaseParameters: GremlinDatabaseCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams): Promise<GremlinDatabaseGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

createUpdateGremlinDatabaseParameters

GremlinDatabaseCreateUpdateParameters

The parameters to provide for the current Gremlin database.

options

GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams

The options parameters.

Returns

Promise<GremlinDatabaseGetResults>

beginCreateUpdateGremlinGraph(string, string, string, string, GremlinGraphCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinGraphOptionalParams)

Create or update an Azure Cosmos DB Gremlin graph

function beginCreateUpdateGremlinGraph(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, createUpdateGremlinGraphParameters: GremlinGraphCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinGraphOptionalParams): Promise<SimplePollerLike<OperationState<GremlinGraphGetResults>, GremlinGraphGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options

GremlinResourcesCreateUpdateGremlinGraphOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GremlinGraphGetResults>, GremlinGraphGetResults>>

beginCreateUpdateGremlinGraphAndWait(string, string, string, string, GremlinGraphCreateUpdateParameters, GremlinResourcesCreateUpdateGremlinGraphOptionalParams)

Create or update an Azure Cosmos DB Gremlin graph

function beginCreateUpdateGremlinGraphAndWait(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, createUpdateGremlinGraphParameters: GremlinGraphCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinGraphOptionalParams): Promise<GremlinGraphGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options

GremlinResourcesCreateUpdateGremlinGraphOptionalParams

The options parameters.

Returns

Promise<GremlinGraphGetResults>

beginDeleteGremlinDatabase(string, string, string, GremlinResourcesDeleteGremlinDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB Gremlin database.

function beginDeleteGremlinDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesDeleteGremlinDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<GremlinResourcesDeleteGremlinDatabaseHeaders>, GremlinResourcesDeleteGremlinDatabaseHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesDeleteGremlinDatabaseOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GremlinResourcesDeleteGremlinDatabaseHeaders>, GremlinResourcesDeleteGremlinDatabaseHeaders>>

beginDeleteGremlinDatabaseAndWait(string, string, string, GremlinResourcesDeleteGremlinDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB Gremlin database.

function beginDeleteGremlinDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesDeleteGremlinDatabaseOptionalParams): Promise<GremlinResourcesDeleteGremlinDatabaseHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesDeleteGremlinDatabaseOptionalParams

The options parameters.

Returns

Promise<GremlinResourcesDeleteGremlinDatabaseHeaders>

beginDeleteGremlinGraph(string, string, string, string, GremlinResourcesDeleteGremlinGraphOptionalParams)

Deletes an existing Azure Cosmos DB Gremlin graph.

function beginDeleteGremlinGraph(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesDeleteGremlinGraphOptionalParams): Promise<SimplePollerLike<OperationState<GremlinResourcesDeleteGremlinGraphHeaders>, GremlinResourcesDeleteGremlinGraphHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesDeleteGremlinGraphOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GremlinResourcesDeleteGremlinGraphHeaders>, GremlinResourcesDeleteGremlinGraphHeaders>>

beginDeleteGremlinGraphAndWait(string, string, string, string, GremlinResourcesDeleteGremlinGraphOptionalParams)

Deletes an existing Azure Cosmos DB Gremlin graph.

function beginDeleteGremlinGraphAndWait(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesDeleteGremlinGraphOptionalParams): Promise<GremlinResourcesDeleteGremlinGraphHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesDeleteGremlinGraphOptionalParams

The options parameters.

Returns

Promise<GremlinResourcesDeleteGremlinGraphHeaders>

beginMigrateGremlinDatabaseToAutoscale(string, string, string, GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale

function beginMigrateGremlinDatabaseToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateGremlinDatabaseToAutoscaleAndWait(string, string, string, GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale

function beginMigrateGremlinDatabaseToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginMigrateGremlinDatabaseToManualThroughput(string, string, string, GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput

function beginMigrateGremlinDatabaseToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateGremlinDatabaseToManualThroughputAndWait(string, string, string, GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput

function beginMigrateGremlinDatabaseToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginMigrateGremlinGraphToAutoscale(string, string, string, string, GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale

function beginMigrateGremlinGraphToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateGremlinGraphToAutoscaleAndWait(string, string, string, string, GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale

function beginMigrateGremlinGraphToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginMigrateGremlinGraphToManualThroughput(string, string, string, string, GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput

function beginMigrateGremlinGraphToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateGremlinGraphToManualThroughputAndWait(string, string, string, string, GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput

function beginMigrateGremlinGraphToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginRetrieveContinuousBackupInformation(string, string, string, string, ContinuousBackupRestoreLocation, GremlinResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a gremlin graph.

function beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, location: ContinuousBackupRestoreLocation, options?: GremlinResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

location

ContinuousBackupRestoreLocation

The name of the continuous backup restore location.

options

GremlinResourcesRetrieveContinuousBackupInformationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

beginRetrieveContinuousBackupInformationAndWait(string, string, string, string, ContinuousBackupRestoreLocation, GremlinResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a gremlin graph.

function beginRetrieveContinuousBackupInformationAndWait(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, location: ContinuousBackupRestoreLocation, options?: GremlinResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<BackupInformation>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

location

ContinuousBackupRestoreLocation

The name of the continuous backup restore location.

options

GremlinResourcesRetrieveContinuousBackupInformationOptionalParams

The options parameters.

Returns

Promise<BackupInformation>

beginUpdateGremlinDatabaseThroughput(string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Gremlin database

function beginUpdateGremlinDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options

GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginUpdateGremlinDatabaseThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Gremlin database

function beginUpdateGremlinDatabaseThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options

GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

beginUpdateGremlinGraphThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinGraphThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Gremlin graph

function beginUpdateGremlinGraphThroughput(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinGraphThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options

GremlinResourcesUpdateGremlinGraphThroughputOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginUpdateGremlinGraphThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, GremlinResourcesUpdateGremlinGraphThroughputOptionalParams)

Update RUs per second of an Azure Cosmos DB Gremlin graph

function beginUpdateGremlinGraphThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinGraphThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options

GremlinResourcesUpdateGremlinGraphThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

getGremlinDatabase(string, string, string, GremlinResourcesGetGremlinDatabaseOptionalParams)

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

function getGremlinDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesGetGremlinDatabaseOptionalParams): Promise<GremlinDatabaseGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesGetGremlinDatabaseOptionalParams

The options parameters.

Returns

Promise<GremlinDatabaseGetResults>

getGremlinDatabaseThroughput(string, string, string, GremlinResourcesGetGremlinDatabaseThroughputOptionalParams)

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

function getGremlinDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesGetGremlinDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesGetGremlinDatabaseThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

getGremlinGraph(string, string, string, string, GremlinResourcesGetGremlinGraphOptionalParams)

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

function getGremlinGraph(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesGetGremlinGraphOptionalParams): Promise<GremlinGraphGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesGetGremlinGraphOptionalParams

The options parameters.

Returns

Promise<GremlinGraphGetResults>

getGremlinGraphThroughput(string, string, string, string, GremlinResourcesGetGremlinGraphThroughputOptionalParams)

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

function getGremlinGraphThroughput(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesGetGremlinGraphThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

graphName

string

Cosmos DB graph name.

options

GremlinResourcesGetGremlinGraphThroughputOptionalParams

The options parameters.

Returns

Promise<ThroughputSettingsGetResults>

listGremlinDatabases(string, string, GremlinResourcesListGremlinDatabasesOptionalParams)

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

function listGremlinDatabases(resourceGroupName: string, accountName: string, options?: GremlinResourcesListGremlinDatabasesOptionalParams): PagedAsyncIterableIterator<GremlinDatabaseGetResults, GremlinDatabaseGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

options

GremlinResourcesListGremlinDatabasesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GremlinDatabaseGetResults, GremlinDatabaseGetResults[], PageSettings>

listGremlinGraphs(string, string, string, GremlinResourcesListGremlinGraphsOptionalParams)

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

function listGremlinGraphs(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesListGremlinGraphsOptionalParams): PagedAsyncIterableIterator<GremlinGraphGetResults, GremlinGraphGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options

GremlinResourcesListGremlinGraphsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GremlinGraphGetResults, GremlinGraphGetResults[], PageSettings>