GremlinResourcesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:gremlin_resources> attribute.

Inheritance

builtins.object

GremlinResourcesOperations

Constructor

GremlinResourcesOperations(*args, **kwargs)

Methods

begin_create_update_gremlin_database	Create or update an Azure Cosmos DB Gremlin database.
begin_create_update_gremlin_graph	Create or update an Azure Cosmos DB Gremlin graph.
begin_delete_gremlin_database	Deletes an existing Azure Cosmos DB Gremlin database.
begin_delete_gremlin_graph	Deletes an existing Azure Cosmos DB Gremlin graph.
begin_migrate_gremlin_database_to_autoscale	Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale.
begin_migrate_gremlin_database_to_manual_throughput	Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput.
begin_migrate_gremlin_graph_to_autoscale	Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale.
begin_migrate_gremlin_graph_to_manual_throughput	Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput.
begin_retrieve_continuous_backup_information	Retrieves continuous backup information for a gremlin graph.
begin_update_gremlin_database_throughput	Update RUs per second of an Azure Cosmos DB Gremlin database.
begin_update_gremlin_graph_throughput	Update RUs per second of an Azure Cosmos DB Gremlin graph.
get_gremlin_database	Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
get_gremlin_database_throughput	Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.
get_gremlin_graph	Gets the Gremlin graph under an existing Azure Cosmos DB database account.
get_gremlin_graph_throughput	Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
list_gremlin_databases	Lists the Gremlin databases under an existing Azure Cosmos DB database account.
list_gremlin_graphs	Lists the Gremlin graph under an existing Azure Cosmos DB database account.

begin_create_update_gremlin_database

Create or update an Azure Cosmos DB Gremlin database.

async begin_create_update_gremlin_database(resource_group_name: str, account_name: str, database_name: str, create_update_gremlin_database_parameters: _models.GremlinDatabaseCreateUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.GremlinDatabaseGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
create_update_gremlin_database_parameters Required	GremlinDatabaseCreateUpdateParameters or IO[bytes] The parameters to provide for the current Gremlin database. Is either a GremlinDatabaseCreateUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[GremlinDatabaseGetResults]	An instance of AsyncLROPoller that returns either GremlinDatabaseGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_update_gremlin_graph

Create or update an Azure Cosmos DB Gremlin graph.

async begin_create_update_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, create_update_gremlin_graph_parameters: _models.GremlinGraphCreateUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.GremlinGraphGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.
create_update_gremlin_graph_parameters Required	GremlinGraphCreateUpdateParameters or IO[bytes] The parameters to provide for the current Gremlin graph. Is either a GremlinGraphCreateUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[GremlinGraphGetResults]	An instance of AsyncLROPoller that returns either GremlinGraphGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_gremlin_database

Deletes an existing Azure Cosmos DB Gremlin database.

async begin_delete_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_gremlin_graph

Deletes an existing Azure Cosmos DB Gremlin graph.

async begin_delete_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_gremlin_database_to_autoscale

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

async begin_migrate_gremlin_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_gremlin_database_to_manual_throughput

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

async begin_migrate_gremlin_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_gremlin_graph_to_autoscale

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

async begin_migrate_gremlin_graph_to_autoscale(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_gremlin_graph_to_manual_throughput

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

async begin_migrate_gremlin_graph_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_retrieve_continuous_backup_information

Retrieves continuous backup information for a gremlin graph.

async begin_retrieve_continuous_backup_information(resource_group_name: str, account_name: str, database_name: str, graph_name: str, location: _models.ContinuousBackupRestoreLocation, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.BackupInformation]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.
location Required	ContinuousBackupRestoreLocation or IO[bytes] The name of the continuous backup restore location. Is either a ContinuousBackupRestoreLocation type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[BackupInformation]	An instance of AsyncLROPoller that returns either BackupInformation or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_gremlin_database_throughput

Update RUs per second of an Azure Cosmos DB Gremlin database.

async begin_update_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
update_throughput_parameters Required	ThroughputSettingsUpdateParameters or IO[bytes] The RUs per second of the parameters to provide for the current Gremlin database. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_gremlin_graph_throughput

Update RUs per second of an Azure Cosmos DB Gremlin graph.

async begin_update_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.
update_throughput_parameters Required	ThroughputSettingsUpdateParameters or IO[bytes] The RUs per second of the parameters to provide for the current Gremlin graph. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_gremlin_database

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

async get_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> GremlinDatabaseGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.

Returns

Type	Description
GremlinDatabaseGetResults	GremlinDatabaseGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_gremlin_database_throughput

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

async get_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> ThroughputSettingsGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.

Returns

Type	Description
ThroughputSettingsGetResults	ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_gremlin_graph

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

async get_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> GremlinGraphGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.

Returns

Type	Description
GremlinGraphGetResults	GremlinGraphGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_gremlin_graph_throughput

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

async get_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> ThroughputSettingsGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.
graph_name Required	str Cosmos DB graph name. Required.

Returns

Type	Description
ThroughputSettingsGetResults	ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_gremlin_databases

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

list_gremlin_databases(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[GremlinDatabaseGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.

Returns

Type	Description
AsyncItemPaged[GremlinDatabaseGetResults]	An iterator like instance of either GremlinDatabaseGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_gremlin_graphs

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

list_gremlin_graphs(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> AsyncIterable[GremlinGraphGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
database_name Required	str Cosmos DB database name. Required.

Returns

Type	Description
AsyncItemPaged[GremlinGraphGetResults]	An iterator like instance of either GremlinGraphGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>