GremlinResourcesImpl | @azure/arm-cosmosdb

Class containing GremlinResources operations.

Hierarchy

GremlinResourcesImpl

Implements

GremlinResources

Index

Constructors

constructor

Methods

Constructors

constructor

new GremlinResourcesImpl(client: CosmosDBManagementClient): GremlinResourcesImpl

- Defined in operations/gremlinResources.ts:61
Initialize a new instance of the class GremlinResources class.

Parameters
- client: CosmosDBManagementClient
  
  Reference to the service client
Returns GremlinResourcesImpl

Methods

beginCreateUpdateGremlinDatabase

beginCreateUpdateGremlinDatabase(resourceGroupName: string, accountName: string, databaseName: string, createUpdateGremlinDatabaseParameters: GremlinDatabaseCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesCreateUpdateGremlinDatabaseResponse>, GremlinResourcesCreateUpdateGremlinDatabaseResponse>>

Implementation of GremlinResources.beginCreateUpdateGremlinDatabase
- Defined in operations/gremlinResources.ts:245
Create or update an Azure Cosmos DB Gremlin database

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.
- Optional options: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesCreateUpdateGremlinDatabaseResponse>, GremlinResourcesCreateUpdateGremlinDatabaseResponse>>

beginCreateUpdateGremlinDatabaseAndWait

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

Implementation of GremlinResources.beginCreateUpdateGremlinDatabaseAndWait
- Defined in operations/gremlinResources.ts:324
Create or update an Azure Cosmos DB Gremlin database

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.
- Optional options: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesCreateUpdateGremlinDatabaseResponse>

beginCreateUpdateGremlinGraph

beginCreateUpdateGremlinGraph(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, createUpdateGremlinGraphParameters: GremlinGraphCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinGraphOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesCreateUpdateGremlinGraphResponse>, GremlinResourcesCreateUpdateGremlinGraphResponse>>

Implementation of GremlinResources.beginCreateUpdateGremlinGraph
- Defined in operations/gremlinResources.ts:792
Create or update an Azure Cosmos DB Gremlin graph

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.
- Optional options: GremlinResourcesCreateUpdateGremlinGraphOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesCreateUpdateGremlinGraphResponse>, GremlinResourcesCreateUpdateGremlinGraphResponse>>

beginCreateUpdateGremlinGraphAndWait

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

Implementation of GremlinResources.beginCreateUpdateGremlinGraphAndWait
- Defined in operations/gremlinResources.ts:873
Create or update an Azure Cosmos DB Gremlin graph

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.
- Optional options: GremlinResourcesCreateUpdateGremlinGraphOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesCreateUpdateGremlinGraphResponse>

beginDeleteGremlinDatabase

beginDeleteGremlinDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesDeleteGremlinDatabaseOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of GremlinResources.beginDeleteGremlinDatabase
- Defined in operations/gremlinResources.ts:348
Deletes an existing Azure Cosmos DB Gremlin database.

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.
- Optional options: GremlinResourcesDeleteGremlinDatabaseOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteGremlinDatabaseAndWait

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

Implementation of GremlinResources.beginDeleteGremlinDatabaseAndWait
- Defined in operations/gremlinResources.ts:413
Deletes an existing Azure Cosmos DB Gremlin database.

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.
- Optional options: GremlinResourcesDeleteGremlinDatabaseOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteGremlinGraph

beginDeleteGremlinGraph(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesDeleteGremlinGraphOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of GremlinResources.beginDeleteGremlinGraph
- Defined in operations/gremlinResources.ts:900
Deletes an existing Azure Cosmos DB Gremlin graph.

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.
- Optional options: GremlinResourcesDeleteGremlinGraphOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteGremlinGraphAndWait

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

Implementation of GremlinResources.beginDeleteGremlinGraphAndWait
- Defined in operations/gremlinResources.ts:967
Deletes an existing Azure Cosmos DB Gremlin graph.

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.
- Optional options: GremlinResourcesDeleteGremlinGraphOptionalParams
  
  The options parameters.
Returns Promise<void>

beginMigrateGremlinDatabaseToAutoscale

beginMigrateGremlinDatabaseToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinDatabaseToAutoscaleResponse>, GremlinResourcesMigrateGremlinDatabaseToAutoscaleResponse>>

Implementation of GremlinResources.beginMigrateGremlinDatabaseToAutoscale
- Defined in operations/gremlinResources.ts:562
Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale

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.
- Optional options: GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinDatabaseToAutoscaleResponse>, GremlinResourcesMigrateGremlinDatabaseToAutoscaleResponse>>

beginMigrateGremlinDatabaseToAutoscaleAndWait

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

Implementation of GremlinResources.beginMigrateGremlinDatabaseToAutoscaleAndWait
- Defined in operations/gremlinResources.ts:634
Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale

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.
- Optional options: GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesMigrateGremlinDatabaseToAutoscaleResponse>

beginMigrateGremlinDatabaseToManualThroughput

beginMigrateGremlinDatabaseToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinDatabaseToManualThroughputResponse>, GremlinResourcesMigrateGremlinDatabaseToManualThroughputResponse>>

Implementation of GremlinResources.beginMigrateGremlinDatabaseToManualThroughput
- Defined in operations/gremlinResources.ts:656
Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput

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.
- Optional options: GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinDatabaseToManualThroughputResponse>, GremlinResourcesMigrateGremlinDatabaseToManualThroughputResponse>>

beginMigrateGremlinDatabaseToManualThroughputAndWait

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

Implementation of GremlinResources.beginMigrateGremlinDatabaseToManualThroughputAndWait
- Defined in operations/gremlinResources.ts:728
Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput

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.
- Optional options: GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesMigrateGremlinDatabaseToManualThroughputResponse>

beginMigrateGremlinGraphToAutoscale

beginMigrateGremlinGraphToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinGraphToAutoscaleResponse>, GremlinResourcesMigrateGremlinGraphToAutoscaleResponse>>

Implementation of GremlinResources.beginMigrateGremlinGraphToAutoscale
- Defined in operations/gremlinResources.ts:1125
Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale

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.
- Optional options: GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinGraphToAutoscaleResponse>, GremlinResourcesMigrateGremlinGraphToAutoscaleResponse>>

beginMigrateGremlinGraphToAutoscaleAndWait

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

Implementation of GremlinResources.beginMigrateGremlinGraphToAutoscaleAndWait
- Defined in operations/gremlinResources.ts:1199
Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale

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.
- Optional options: GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesMigrateGremlinGraphToAutoscaleResponse>

beginMigrateGremlinGraphToManualThroughput

beginMigrateGremlinGraphToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinGraphToManualThroughputResponse>, GremlinResourcesMigrateGremlinGraphToManualThroughputResponse>>

Implementation of GremlinResources.beginMigrateGremlinGraphToManualThroughput
- Defined in operations/gremlinResources.ts:1224
Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput

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.
- Optional options: GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesMigrateGremlinGraphToManualThroughputResponse>, GremlinResourcesMigrateGremlinGraphToManualThroughputResponse>>

beginMigrateGremlinGraphToManualThroughputAndWait

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

Implementation of GremlinResources.beginMigrateGremlinGraphToManualThroughputAndWait
- Defined in operations/gremlinResources.ts:1298
Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput

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.
- Optional options: GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesMigrateGremlinGraphToManualThroughputResponse>

beginRetrieveContinuousBackupInformation

beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, location: ContinuousBackupRestoreLocation, options?: GremlinResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesRetrieveContinuousBackupInformationResponse>, GremlinResourcesRetrieveContinuousBackupInformationResponse>>

Implementation of GremlinResources.beginRetrieveContinuousBackupInformation
- Defined in operations/gremlinResources.ts:1324
Retrieves continuous backup information for a gremlin graph.

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.
- Optional options: GremlinResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesRetrieveContinuousBackupInformationResponse>, GremlinResourcesRetrieveContinuousBackupInformationResponse>>

beginRetrieveContinuousBackupInformationAndWait

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

Implementation of GremlinResources.beginRetrieveContinuousBackupInformationAndWait
- Defined in operations/gremlinResources.ts:1408
Retrieves continuous backup information for a gremlin graph.

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.
- Optional options: GremlinResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesRetrieveContinuousBackupInformationResponse>

beginUpdateGremlinDatabaseThroughput

beginUpdateGremlinDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesUpdateGremlinDatabaseThroughputResponse>, GremlinResourcesUpdateGremlinDatabaseThroughputResponse>>

Implementation of GremlinResources.beginUpdateGremlinDatabaseThroughput
- Defined in operations/gremlinResources.ts:457
Update RUs per second of an Azure Cosmos DB Gremlin database

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.
- Optional options: GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesUpdateGremlinDatabaseThroughputResponse>, GremlinResourcesUpdateGremlinDatabaseThroughputResponse>>

beginUpdateGremlinDatabaseThroughputAndWait

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

Implementation of GremlinResources.beginUpdateGremlinDatabaseThroughputAndWait
- Defined in operations/gremlinResources.ts:538
Update RUs per second of an Azure Cosmos DB Gremlin database

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.
- Optional options: GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesUpdateGremlinDatabaseThroughputResponse>

beginUpdateGremlinGraphThroughput

beginUpdateGremlinGraphThroughput(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinGraphThroughputOptionalParams): Promise<PollerLike<PollOperationState<GremlinResourcesUpdateGremlinGraphThroughputResponse>, GremlinResourcesUpdateGremlinGraphThroughputResponse>>

Implementation of GremlinResources.beginUpdateGremlinGraphThroughput
- Defined in operations/gremlinResources.ts:1016
Update RUs per second of an Azure Cosmos DB Gremlin graph

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.
- Optional options: GremlinResourcesUpdateGremlinGraphThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GremlinResourcesUpdateGremlinGraphThroughputResponse>, GremlinResourcesUpdateGremlinGraphThroughputResponse>>

beginUpdateGremlinGraphThroughputAndWait

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

Implementation of GremlinResources.beginUpdateGremlinGraphThroughputAndWait
- Defined in operations/gremlinResources.ts:1098
Update RUs per second of an Azure Cosmos DB Gremlin graph

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.
- Optional options: GremlinResourcesUpdateGremlinGraphThroughputOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesUpdateGremlinGraphThroughputResponse>

getGremlinDatabase

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

Implementation of GremlinResources.getGremlinDatabase
- Defined in operations/gremlinResources.ts:224
Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: GremlinResourcesGetGremlinDatabaseOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesGetGremlinDatabaseResponse>

getGremlinDatabaseThroughput

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

Implementation of GremlinResources.getGremlinDatabaseThroughput
- Defined in operations/gremlinResources.ts:436
Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: GremlinResourcesGetGremlinDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesGetGremlinDatabaseThroughputResponse>

getGremlinGraph

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

Implementation of GremlinResources.getGremlinGraph
- Defined in operations/gremlinResources.ts:770
Gets the Gremlin graph under an existing Azure Cosmos DB database account.

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.
- Optional options: GremlinResourcesGetGremlinGraphOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesGetGremlinGraphResponse>

getGremlinGraphThroughput

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

Implementation of GremlinResources.getGremlinGraphThroughput
- Defined in operations/gremlinResources.ts:993
Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: GremlinResourcesGetGremlinGraphThroughputOptionalParams
  
  The options parameters.
Returns Promise<GremlinResourcesGetGremlinGraphThroughputResponse>

listGremlinDatabases

listGremlinDatabases(resourceGroupName: string, accountName: string, options?: GremlinResourcesListGremlinDatabasesOptionalParams): PagedAsyncIterableIterator<GremlinDatabaseGetResults>

Implementation of GremlinResources.listGremlinDatabases
- Defined in operations/gremlinResources.ts:77
Lists the Gremlin databases under an existing Azure Cosmos DB database account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: GremlinResourcesListGremlinDatabasesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GremlinDatabaseGetResults>

listGremlinGraphs

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

Implementation of GremlinResources.listGremlinGraphs
- Defined in operations/gremlinResources.ts:138
Lists the Gremlin graph under an existing Azure Cosmos DB database account.

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.
- Optional options: GremlinResourcesListGremlinGraphsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GremlinGraphGetResults>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CosmosDBManagementClient

Returns GremlinResourcesImpl

Methods

beginCreateUpdateGremlinDatabase

Parameters

resourceGroupName: string

accountName: string

databaseName: string

createUpdateGremlinDatabaseParameters: GremlinDatabaseCreateUpdateParameters

Optional options: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams

Returns Promise<PollerLike<PollOperationState<GremlinResourcesCreateUpdateGremlinDatabaseResponse>, GremlinResourcesCreateUpdateGremlinDatabaseResponse>>

beginCreateUpdateGremlinDatabaseAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

createUpdateGremlinDatabaseParameters: GremlinDatabaseCreateUpdateParameters

Optional options: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams

Returns Promise<GremlinResourcesCreateUpdateGremlinDatabaseResponse>

beginCreateUpdateGremlinGraph

Parameters

resourceGroupName: string

accountName: string

databaseName: string

graphName: string

createUpdateGremlinGraphParameters: GremlinGraphCreateUpdateParameters

Optional options: GremlinResourcesCreateUpdateGremlinGraphOptionalParams

Returns Promise<PollerLike<PollOperationState<GremlinResourcesCreateUpdateGremlinGraphResponse>, GremlinResourcesCreateUpdateGremlinGraphResponse>>

beginCreateUpdateGremlinGraphAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

graphName: string

createUpdateGremlinGraphParameters: GremlinGraphCreateUpdateParameters

Optional options: GremlinResourcesCreateUpdateGremlinGraphOptionalParams

Returns Promise<GremlinResourcesCreateUpdateGremlinGraphResponse>

beginDeleteGremlinDatabase

Parameters

resourceGroupName: string

accountName: string

databaseName: string

Optional options: GremlinResourcesDeleteGremlinDatabaseOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteGremlinDatabaseAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

Optional options: GremlinResourcesDeleteGremlinDatabaseOptionalParams

Returns Promise<void>

beginDeleteGremlinGraph

Parameters

resourceGroupName: string

accountName: string

databaseName: string

graphName: string

Optional options: GremlinResourcesDeleteGremlinGraphOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteGremlinGraphAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

graphName: string

Optional options: GremlinResourcesDeleteGremlinGraphOptionalParams

Returns Promise<void>

beginMigrateGremlinDatabaseToAutoscale

Parameters

resourceGroupName: string

accountName: string

databaseName: string