GremlinResourcesOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a GremlinResources operations.

Properties

beginCreateUpdateGremlinDatabase
beginCreateUpdateGremlinDatabaseAndWait
beginCreateUpdateGremlinGraph
beginCreateUpdateGremlinGraphAndWait
beginCreateUpdateGremlinRoleAssignment
beginCreateUpdateGremlinRoleAssignmentAndWait
beginCreateUpdateGremlinRoleDefinition
beginCreateUpdateGremlinRoleDefinitionAndWait
beginDeleteGremlinDatabase
beginDeleteGremlinDatabaseAndWait
beginDeleteGremlinGraph
beginDeleteGremlinGraphAndWait
beginDeleteGremlinRoleAssignment
beginDeleteGremlinRoleAssignmentAndWait
beginDeleteGremlinRoleDefinition
beginDeleteGremlinRoleDefinitionAndWait
beginMigrateGremlinDatabaseToAutoscale
beginMigrateGremlinDatabaseToAutoscaleAndWait
beginMigrateGremlinDatabaseToManualThroughput
beginMigrateGremlinDatabaseToManualThroughputAndWait
beginMigrateGremlinGraphToAutoscale
beginMigrateGremlinGraphToAutoscaleAndWait
beginMigrateGremlinGraphToManualThroughput
beginMigrateGremlinGraphToManualThroughputAndWait
beginRetrieveContinuousBackupInformation
beginRetrieveContinuousBackupInformationAndWait
beginUpdateGremlinDatabaseThroughput
beginUpdateGremlinDatabaseThroughputAndWait
beginUpdateGremlinGraphThroughput
beginUpdateGremlinGraphThroughputAndWait
createUpdateGremlinDatabase	Create or update an Azure Cosmos DB Gremlin database
createUpdateGremlinGraph	Create or update an Azure Cosmos DB Gremlin graph
createUpdateGremlinRoleAssignment	Creates or updates an Azure Cosmos DB Gremlin Role Assignment.
createUpdateGremlinRoleDefinition	Creates or updates an Azure Cosmos DB Gremlin Role Definition.
deleteGremlinDatabase	Deletes an existing Azure Cosmos DB Gremlin database.
deleteGremlinGraph	Deletes an existing Azure Cosmos DB Gremlin graph.
deleteGremlinRoleAssignment	Deletes an existing Azure Cosmos DB Gremlin Role Assignment.
deleteGremlinRoleDefinition	Deletes an existing Azure Cosmos DB Gremlin Role Definition.
getGremlinDatabase	Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
getGremlinDatabaseThroughput	Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
getGremlinGraph	Gets the Gremlin graph under an existing Azure Cosmos DB database account.
getGremlinGraphThroughput	Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
getGremlinRoleAssignment	Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id.
getGremlinRoleDefinition	Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id.
listGremlinDatabases	Lists the Gremlin databases under an existing Azure Cosmos DB database account.
listGremlinGraphs	Lists the Gremlin graph under an existing Azure Cosmos DB database account.
listGremlinRoleAssignments	Retrieves the list of all Azure Cosmos DB Gremlin Role Assignments.
listGremlinRoleDefinitions	Retrieves the list of all Azure Cosmos DB Gremlin Role Definitions.
migrateGremlinDatabaseToAutoscale	Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale
migrateGremlinDatabaseToManualThroughput	Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput
migrateGremlinGraphToAutoscale	Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale
migrateGremlinGraphToManualThroughput	Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput
retrieveContinuousBackupInformation	Retrieves continuous backup information for a gremlin graph.
updateGremlinDatabaseThroughput	Update RUs per second of an Azure Cosmos DB Gremlin database
updateGremlinGraphThroughput	Update RUs per second of an Azure Cosmos DB Gremlin graph

Property Details

beginCreateUpdateGremlinDatabase

Warning

This API is now deprecated.

use createUpdateGremlinDatabase instead

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

Property Value

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

beginCreateUpdateGremlinDatabaseAndWait

Warning

This API is now deprecated.

use createUpdateGremlinDatabase instead

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

Property Value

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

beginCreateUpdateGremlinGraph

Warning

This API is now deprecated.

use createUpdateGremlinGraph instead

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

Property Value

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

beginCreateUpdateGremlinGraphAndWait

Warning

This API is now deprecated.

use createUpdateGremlinGraph instead

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

Property Value

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

beginCreateUpdateGremlinRoleAssignment

Warning

This API is now deprecated.

use createUpdateGremlinRoleAssignment instead

beginCreateUpdateGremlinRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateGremlinRoleAssignmentParameters: GremlinRoleAssignmentResource, options?: GremlinResourcesCreateUpdateGremlinRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<GremlinRoleAssignmentResource>, GremlinRoleAssignmentResource>>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateGremlinRoleAssignmentParameters: GremlinRoleAssignmentResource, options?: GremlinResourcesCreateUpdateGremlinRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<GremlinRoleAssignmentResource>, GremlinRoleAssignmentResource>>

beginCreateUpdateGremlinRoleAssignmentAndWait

Warning

This API is now deprecated.

use createUpdateGremlinRoleAssignment instead

beginCreateUpdateGremlinRoleAssignmentAndWait: (resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateGremlinRoleAssignmentParameters: GremlinRoleAssignmentResource, options?: GremlinResourcesCreateUpdateGremlinRoleAssignmentOptionalParams) => Promise<GremlinRoleAssignmentResource>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateGremlinRoleAssignmentParameters: GremlinRoleAssignmentResource, options?: GremlinResourcesCreateUpdateGremlinRoleAssignmentOptionalParams) => Promise<GremlinRoleAssignmentResource>

beginCreateUpdateGremlinRoleDefinition

Warning

This API is now deprecated.

use createUpdateGremlinRoleDefinition instead

beginCreateUpdateGremlinRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateGremlinRoleDefinitionParameters: GremlinRoleDefinitionResource, options?: GremlinResourcesCreateUpdateGremlinRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<GremlinRoleDefinitionResource>, GremlinRoleDefinitionResource>>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateGremlinRoleDefinitionParameters: GremlinRoleDefinitionResource, options?: GremlinResourcesCreateUpdateGremlinRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<GremlinRoleDefinitionResource>, GremlinRoleDefinitionResource>>

beginCreateUpdateGremlinRoleDefinitionAndWait

Warning

This API is now deprecated.

use createUpdateGremlinRoleDefinition instead

beginCreateUpdateGremlinRoleDefinitionAndWait: (resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateGremlinRoleDefinitionParameters: GremlinRoleDefinitionResource, options?: GremlinResourcesCreateUpdateGremlinRoleDefinitionOptionalParams) => Promise<GremlinRoleDefinitionResource>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateGremlinRoleDefinitionParameters: GremlinRoleDefinitionResource, options?: GremlinResourcesCreateUpdateGremlinRoleDefinitionOptionalParams) => Promise<GremlinRoleDefinitionResource>

beginDeleteGremlinDatabase

Warning

This API is now deprecated.

use deleteGremlinDatabase instead

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

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesDeleteGremlinDatabaseOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteGremlinDatabaseAndWait

Warning

This API is now deprecated.

use deleteGremlinDatabase instead

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

Property Value

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

beginDeleteGremlinGraph

Warning

This API is now deprecated.

use deleteGremlinGraph instead

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

Property Value

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

beginDeleteGremlinGraphAndWait

Warning

This API is now deprecated.

use deleteGremlinGraph instead

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

Property Value

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

beginDeleteGremlinRoleAssignment

Warning

This API is now deprecated.

use deleteGremlinRoleAssignment instead

beginDeleteGremlinRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesDeleteGremlinRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesDeleteGremlinRoleAssignmentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteGremlinRoleAssignmentAndWait

Warning

This API is now deprecated.

use deleteGremlinRoleAssignment instead

beginDeleteGremlinRoleAssignmentAndWait: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesDeleteGremlinRoleAssignmentOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesDeleteGremlinRoleAssignmentOptionalParams) => Promise<void>

beginDeleteGremlinRoleDefinition

Warning

This API is now deprecated.

use deleteGremlinRoleDefinition instead

beginDeleteGremlinRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesDeleteGremlinRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesDeleteGremlinRoleDefinitionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteGremlinRoleDefinitionAndWait

Warning

This API is now deprecated.

use deleteGremlinRoleDefinition instead

beginDeleteGremlinRoleDefinitionAndWait: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesDeleteGremlinRoleDefinitionOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesDeleteGremlinRoleDefinitionOptionalParams) => Promise<void>

beginMigrateGremlinDatabaseToAutoscale

Warning

This API is now deprecated.

use migrateGremlinDatabaseToAutoscale instead

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

Property Value

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

beginMigrateGremlinDatabaseToAutoscaleAndWait

Warning

This API is now deprecated.

use migrateGremlinDatabaseToAutoscale instead

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

Property Value

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

beginMigrateGremlinDatabaseToManualThroughput

Warning

This API is now deprecated.

use migrateGremlinDatabaseToManualThroughput instead

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

Property Value

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

beginMigrateGremlinDatabaseToManualThroughputAndWait

Warning

This API is now deprecated.

use migrateGremlinDatabaseToManualThroughput instead

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

Property Value

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

beginMigrateGremlinGraphToAutoscale

Warning

This API is now deprecated.

use migrateGremlinGraphToAutoscale instead

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

Property Value

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

beginMigrateGremlinGraphToAutoscaleAndWait

Warning

This API is now deprecated.

use migrateGremlinGraphToAutoscale instead

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

Property Value

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

beginMigrateGremlinGraphToManualThroughput

Warning

This API is now deprecated.

use migrateGremlinGraphToManualThroughput instead

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

Property Value

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

beginMigrateGremlinGraphToManualThroughputAndWait

Warning

This API is now deprecated.

use migrateGremlinGraphToManualThroughput instead

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

Property Value

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

beginRetrieveContinuousBackupInformation

Warning

This API is now deprecated.

use retrieveContinuousBackupInformation instead

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

Property Value

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

beginRetrieveContinuousBackupInformationAndWait

Warning

This API is now deprecated.

use retrieveContinuousBackupInformation instead

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

Property Value

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

beginUpdateGremlinDatabaseThroughput

Warning

This API is now deprecated.

use updateGremlinDatabaseThroughput instead

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

Property Value

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

beginUpdateGremlinDatabaseThroughputAndWait

Warning

This API is now deprecated.

use updateGremlinDatabaseThroughput instead

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

Property Value

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

beginUpdateGremlinGraphThroughput

Warning

This API is now deprecated.

use updateGremlinGraphThroughput instead

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

Property Value

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

beginUpdateGremlinGraphThroughputAndWait

Warning

This API is now deprecated.

use updateGremlinGraphThroughput instead

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

Property Value

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

createUpdateGremlinDatabase

Create or update an Azure Cosmos DB Gremlin database

createUpdateGremlinDatabase: (resourceGroupName: string, accountName: string, databaseName: string, createUpdateGremlinDatabaseParameters: GremlinDatabaseCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams) => PollerLike<OperationState<GremlinDatabaseGetResults>, GremlinDatabaseGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, createUpdateGremlinDatabaseParameters: GremlinDatabaseCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinDatabaseOptionalParams) => PollerLike<OperationState<GremlinDatabaseGetResults>, GremlinDatabaseGetResults>

createUpdateGremlinGraph

Create or update an Azure Cosmos DB Gremlin graph

createUpdateGremlinGraph: (resourceGroupName: string, accountName: string, databaseName: string, graphName: string, createUpdateGremlinGraphParameters: GremlinGraphCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinGraphOptionalParams) => PollerLike<OperationState<GremlinGraphGetResults>, GremlinGraphGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, createUpdateGremlinGraphParameters: GremlinGraphCreateUpdateParameters, options?: GremlinResourcesCreateUpdateGremlinGraphOptionalParams) => PollerLike<OperationState<GremlinGraphGetResults>, GremlinGraphGetResults>

createUpdateGremlinRoleAssignment

Creates or updates an Azure Cosmos DB Gremlin Role Assignment.

createUpdateGremlinRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateGremlinRoleAssignmentParameters: GremlinRoleAssignmentResource, options?: GremlinResourcesCreateUpdateGremlinRoleAssignmentOptionalParams) => PollerLike<OperationState<GremlinRoleAssignmentResource>, GremlinRoleAssignmentResource>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, createUpdateGremlinRoleAssignmentParameters: GremlinRoleAssignmentResource, options?: GremlinResourcesCreateUpdateGremlinRoleAssignmentOptionalParams) => PollerLike<OperationState<GremlinRoleAssignmentResource>, GremlinRoleAssignmentResource>

createUpdateGremlinRoleDefinition

Creates or updates an Azure Cosmos DB Gremlin Role Definition.

createUpdateGremlinRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateGremlinRoleDefinitionParameters: GremlinRoleDefinitionResource, options?: GremlinResourcesCreateUpdateGremlinRoleDefinitionOptionalParams) => PollerLike<OperationState<GremlinRoleDefinitionResource>, GremlinRoleDefinitionResource>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, createUpdateGremlinRoleDefinitionParameters: GremlinRoleDefinitionResource, options?: GremlinResourcesCreateUpdateGremlinRoleDefinitionOptionalParams) => PollerLike<OperationState<GremlinRoleDefinitionResource>, GremlinRoleDefinitionResource>

deleteGremlinDatabase

Deletes an existing Azure Cosmos DB Gremlin database.

deleteGremlinDatabase: (resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesDeleteGremlinDatabaseOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesDeleteGremlinDatabaseOptionalParams) => PollerLike<OperationState<void>, void>

deleteGremlinGraph

Deletes an existing Azure Cosmos DB Gremlin graph.

deleteGremlinGraph: (resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesDeleteGremlinGraphOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesDeleteGremlinGraphOptionalParams) => PollerLike<OperationState<void>, void>

deleteGremlinRoleAssignment

Deletes an existing Azure Cosmos DB Gremlin Role Assignment.

deleteGremlinRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesDeleteGremlinRoleAssignmentOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesDeleteGremlinRoleAssignmentOptionalParams) => PollerLike<OperationState<void>, void>

deleteGremlinRoleDefinition

Deletes an existing Azure Cosmos DB Gremlin Role Definition.

deleteGremlinRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesDeleteGremlinRoleDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesDeleteGremlinRoleDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

getGremlinDatabase

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

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

Property Value

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

getGremlinDatabaseThroughput

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

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

Property Value

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

getGremlinGraph

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

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

Property Value

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

getGremlinGraphThroughput

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

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

Property Value

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

getGremlinRoleAssignment

Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Assignment with the given Id.

getGremlinRoleAssignment: (resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesGetGremlinRoleAssignmentOptionalParams) => Promise<GremlinRoleAssignmentResource>

Property Value

(resourceGroupName: string, accountName: string, roleAssignmentId: string, options?: GremlinResourcesGetGremlinRoleAssignmentOptionalParams) => Promise<GremlinRoleAssignmentResource>

getGremlinRoleDefinition

Retrieves the properties of an existing Azure Cosmos DB Gremlin Role Definition with the given Id.

getGremlinRoleDefinition: (resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesGetGremlinRoleDefinitionOptionalParams) => Promise<GremlinRoleDefinitionResource>

Property Value

(resourceGroupName: string, accountName: string, roleDefinitionId: string, options?: GremlinResourcesGetGremlinRoleDefinitionOptionalParams) => Promise<GremlinRoleDefinitionResource>

listGremlinDatabases

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

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

Property Value

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

listGremlinGraphs

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

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

Property Value

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

listGremlinRoleAssignments

Retrieves the list of all Azure Cosmos DB Gremlin Role Assignments.

listGremlinRoleAssignments: (resourceGroupName: string, accountName: string, options?: GremlinResourcesListGremlinRoleAssignmentsOptionalParams) => PagedAsyncIterableIterator<GremlinRoleAssignmentResource, GremlinRoleAssignmentResource[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: GremlinResourcesListGremlinRoleAssignmentsOptionalParams) => PagedAsyncIterableIterator<GremlinRoleAssignmentResource, GremlinRoleAssignmentResource[], PageSettings>

listGremlinRoleDefinitions

Retrieves the list of all Azure Cosmos DB Gremlin Role Definitions.

listGremlinRoleDefinitions: (resourceGroupName: string, accountName: string, options?: GremlinResourcesListGremlinRoleDefinitionsOptionalParams) => PagedAsyncIterableIterator<GremlinRoleDefinitionResource, GremlinRoleDefinitionResource[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: GremlinResourcesListGremlinRoleDefinitionsOptionalParams) => PagedAsyncIterableIterator<GremlinRoleDefinitionResource, GremlinRoleDefinitionResource[], PageSettings>

migrateGremlinDatabaseToAutoscale

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

migrateGremlinDatabaseToAutoscale: (resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

migrateGremlinDatabaseToManualThroughput

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

migrateGremlinDatabaseToManualThroughput: (resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: GremlinResourcesMigrateGremlinDatabaseToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

migrateGremlinGraphToAutoscale

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

migrateGremlinGraphToAutoscale: (resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

migrateGremlinGraphToManualThroughput

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

migrateGremlinGraphToManualThroughput: (resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, options?: GremlinResourcesMigrateGremlinGraphToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

retrieveContinuousBackupInformation

Retrieves continuous backup information for a gremlin graph.

retrieveContinuousBackupInformation: (resourceGroupName: string, accountName: string, databaseName: string, graphName: string, location: ContinuousBackupRestoreLocation, options?: GremlinResourcesRetrieveContinuousBackupInformationOptionalParams) => PollerLike<OperationState<BackupInformation>, BackupInformation>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, location: ContinuousBackupRestoreLocation, options?: GremlinResourcesRetrieveContinuousBackupInformationOptionalParams) => PollerLike<OperationState<BackupInformation>, BackupInformation>

updateGremlinDatabaseThroughput

Update RUs per second of an Azure Cosmos DB Gremlin database

updateGremlinDatabaseThroughput: (resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinDatabaseThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

updateGremlinGraphThroughput

Update RUs per second of an Azure Cosmos DB Gremlin graph

updateGremlinGraphThroughput: (resourceGroupName: string, accountName: string, databaseName: string, graphName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinGraphThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, graphName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: GremlinResourcesUpdateGremlinGraphThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>