GremlinResourcesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:gremlin_resources> attribute.
- Inheritance
-
builtins.objectGremlinResourcesOperations
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_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.
begin_create_update_gremlin_database(resource_group_name: str, account_name: str, database_name: str, create_update_gremlin_database_parameters: azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseGetResults]Parameters
- create_update_gremlin_database_parameters
- GremlinDatabaseCreateUpdateParameters
The parameters to provide for the current Gremlin database.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either GremlinDatabaseGetResults or the result of cls(response)
Return type
Exceptions
begin_create_update_gremlin_graph
Create or update an Azure Cosmos DB Gremlin graph.
begin_create_update_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, create_update_gremlin_graph_parameters: azure.mgmt.cosmosdb.models._models_py3.GremlinGraphCreateUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.GremlinGraphGetResults]Parameters
- create_update_gremlin_graph_parameters
- GremlinGraphCreateUpdateParameters
The parameters to provide for the current Gremlin graph.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either GremlinGraphGetResults or the result of cls(response)
Return type
Exceptions
begin_delete_gremlin_database
Deletes an existing Azure Cosmos DB Gremlin database.
begin_delete_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_delete_gremlin_graph
Deletes an existing Azure Cosmos DB Gremlin graph.
begin_delete_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_migrate_gremlin_database_to_autoscale
Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale.
begin_migrate_gremlin_database_to_autoscale(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
begin_migrate_gremlin_database_to_manual_throughput
Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput.
begin_migrate_gremlin_database_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
begin_migrate_gremlin_graph_to_autoscale
Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale.
begin_migrate_gremlin_graph_to_autoscale(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
begin_migrate_gremlin_graph_to_manual_throughput
Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput.
begin_migrate_gremlin_graph_to_manual_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
begin_update_gremlin_database_throughput
Update RUs per second of an Azure Cosmos DB Gremlin database.
begin_update_gremlin_database_throughput(resource_group_name: str, account_name: str, database_name: str, update_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- update_throughput_parameters
- ThroughputSettingsUpdateParameters
The RUs per second of the parameters to provide for the current Gremlin database.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
begin_update_gremlin_graph_throughput
Update RUs per second of an Azure Cosmos DB Gremlin graph.
begin_update_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, update_throughput_parameters: azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResults]Parameters
- update_throughput_parameters
- ThroughputSettingsUpdateParameters
The RUs per second of the parameters to provide for the current Gremlin graph.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)
Return type
Exceptions
get_gremlin_database
Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.
get_gremlin_database(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseGetResultsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
GremlinDatabaseGetResults, or the result of cls(response)
Return type
Exceptions
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_database_throughput(resource_group_name: str, account_name: str, database_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResultsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ThroughputSettingsGetResults, or the result of cls(response)
Return type
Exceptions
get_gremlin_graph
Gets the Gremlin graph under an existing Azure Cosmos DB database account.
get_gremlin_graph(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.GremlinGraphGetResultsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
GremlinGraphGetResults, or the result of cls(response)
Return type
Exceptions
get_gremlin_graph_throughput
Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.
get_gremlin_graph_throughput(resource_group_name: str, account_name: str, database_name: str, graph_name: str, **kwargs: Any) -> azure.mgmt.cosmosdb.models._models_py3.ThroughputSettingsGetResultsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ThroughputSettingsGetResults, or the result of cls(response)
Return type
Exceptions
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) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.GremlinDatabaseListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either GremlinDatabaseListResult or the result of cls(response)
Return type
Exceptions
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) -> Iterable[azure.mgmt.cosmosdb.models._models_py3.GremlinGraphListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either GremlinGraphListResult or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>Feedback
Submit and view feedback for