Interface IGremlinResourcesOperations

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

GremlinResourcesOperations operations.

public interface IGremlinResourcesOperations

Extension Methods

GremlinResourcesOperationsExtensions.BeginCreateUpdateGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, GremlinDatabaseCreateUpdateParameters, CancellationToken)

GremlinResourcesOperationsExtensions.BeginCreateUpdateGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, GremlinGraphCreateUpdateParameters, CancellationToken)

GremlinResourcesOperationsExtensions.BeginDeleteGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.BeginDeleteGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.BeginUpdateGremlinDatabaseThroughputAsync(IGremlinResourcesOperations, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

GremlinResourcesOperationsExtensions.BeginUpdateGremlinGraphThroughputAsync(IGremlinResourcesOperations, string, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

GremlinResourcesOperationsExtensions.CreateUpdateGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, GremlinDatabaseCreateUpdateParameters, CancellationToken)

GremlinResourcesOperationsExtensions.CreateUpdateGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, GremlinGraphCreateUpdateParameters, CancellationToken)

GremlinResourcesOperationsExtensions.DeleteGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.DeleteGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.GetGremlinDatabaseAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.GetGremlinDatabaseThroughputAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.GetGremlinGraphAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.GetGremlinGraphThroughputAsync(IGremlinResourcesOperations, string, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.ListGremlinDatabasesAsync(IGremlinResourcesOperations, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.ListGremlinGraphsAsync(IGremlinResourcesOperations, string, string, string, CancellationToken)

GremlinResourcesOperationsExtensions.UpdateGremlinDatabaseThroughputAsync(IGremlinResourcesOperations, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

GremlinResourcesOperationsExtensions.UpdateGremlinGraphThroughputAsync(IGremlinResourcesOperations, string, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Methods

BeginCreateUpdateGremlinDatabaseWithHttpMessagesAsync(string, string, string, GremlinDatabaseCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or update an Azure Cosmos DB Gremlin database

Task<AzureOperationResponse<GremlinDatabaseGetResultsInner>> BeginCreateUpdateGremlinDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, GremlinDatabaseCreateUpdateParameters createUpdateGremlinDatabaseParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters

The parameters to provide for the current Gremlin database.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<GremlinDatabaseGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginCreateUpdateGremlinGraphWithHttpMessagesAsync(string, string, string, string, GremlinGraphCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or update an Azure Cosmos DB Gremlin graph

Task<AzureOperationResponse<GremlinGraphGetResultsInner>> BeginCreateUpdateGremlinGraphWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, GremlinGraphCreateUpdateParameters createUpdateGremlinGraphParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<GremlinGraphGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginDeleteGremlinDatabaseWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin database.

Task<AzureOperationResponse> BeginDeleteGremlinDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginDeleteGremlinGraphWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin graph.

Task<AzureOperationResponse> BeginDeleteGremlinGraphWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginUpdateGremlinDatabaseThroughputWithHttpMessagesAsync(string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin database

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> BeginUpdateGremlinDatabaseThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginUpdateGremlinGraphThroughputWithHttpMessagesAsync(string, string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin graph

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> BeginUpdateGremlinGraphThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

CreateUpdateGremlinDatabaseWithHttpMessagesAsync(string, string, string, GremlinDatabaseCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or update an Azure Cosmos DB Gremlin database

Task<AzureOperationResponse<GremlinDatabaseGetResultsInner>> CreateUpdateGremlinDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, GremlinDatabaseCreateUpdateParameters createUpdateGremlinDatabaseParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters

The parameters to provide for the current Gremlin database.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<GremlinDatabaseGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

CreateUpdateGremlinGraphWithHttpMessagesAsync(string, string, string, string, GremlinGraphCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or update an Azure Cosmos DB Gremlin graph

Task<AzureOperationResponse<GremlinGraphGetResultsInner>> CreateUpdateGremlinGraphWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, GremlinGraphCreateUpdateParameters createUpdateGremlinGraphParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<GremlinGraphGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

DeleteGremlinDatabaseWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin database.

Task<AzureOperationResponse> DeleteGremlinDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

DeleteGremlinGraphWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB Gremlin graph.

Task<AzureOperationResponse> DeleteGremlinGraphWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetGremlinDatabaseThroughputWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> GetGremlinDatabaseThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetGremlinDatabaseWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<GremlinDatabaseGetResultsInner>> GetGremlinDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<GremlinDatabaseGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetGremlinGraphThroughputWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> GetGremlinGraphThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetGremlinGraphWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<GremlinGraphGetResultsInner>> GetGremlinGraphWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

graphName string

Cosmos DB graph name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<GremlinGraphGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListGremlinDatabasesWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<GremlinDatabaseGetResultsInner>>> ListGremlinDatabasesWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<GremlinDatabaseGetResultsInner>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListGremlinGraphsWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<GremlinGraphGetResultsInner>>> ListGremlinGraphsWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<GremlinGraphGetResultsInner>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

UpdateGremlinDatabaseThroughputWithHttpMessagesAsync(string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin database

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> UpdateGremlinDatabaseThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

UpdateGremlinGraphThroughputWithHttpMessagesAsync(string, string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Update RUs per second of an Azure Cosmos DB Gremlin graph

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> UpdateGremlinGraphThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string graphName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null