GraphResourcesOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a GraphResources operations.

Properties

beginCreateUpdateGraph
beginCreateUpdateGraphAndWait
beginDeleteGraphResource
beginDeleteGraphResourceAndWait
createUpdateGraph	Create or update an Azure Cosmos DB Graph.
deleteGraphResource	Deletes an existing Azure Cosmos DB Graph Resource.
getGraph	Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.
listGraphs	Lists the graphs under an existing Azure Cosmos DB database account.

Property Details

beginCreateUpdateGraph

Warning

This API is now deprecated.

use createUpdateGraph instead

beginCreateUpdateGraph: (resourceGroupName: string, accountName: string, graphName: string, createUpdateGraphParameters: GraphResourceCreateUpdateParameters, options?: GraphResourcesCreateUpdateGraphOptionalParams) => Promise<SimplePollerLike<OperationState<GraphResourceGetResults>, GraphResourceGetResults>>

Property Value

(resourceGroupName: string, accountName: string, graphName: string, createUpdateGraphParameters: GraphResourceCreateUpdateParameters, options?: GraphResourcesCreateUpdateGraphOptionalParams) => Promise<SimplePollerLike<OperationState<GraphResourceGetResults>, GraphResourceGetResults>>

beginCreateUpdateGraphAndWait

Warning

This API is now deprecated.

use createUpdateGraph instead

beginCreateUpdateGraphAndWait: (resourceGroupName: string, accountName: string, graphName: string, createUpdateGraphParameters: GraphResourceCreateUpdateParameters, options?: GraphResourcesCreateUpdateGraphOptionalParams) => Promise<GraphResourceGetResults>

Property Value

(resourceGroupName: string, accountName: string, graphName: string, createUpdateGraphParameters: GraphResourceCreateUpdateParameters, options?: GraphResourcesCreateUpdateGraphOptionalParams) => Promise<GraphResourceGetResults>

beginDeleteGraphResource

Warning

This API is now deprecated.

use deleteGraphResource instead

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

Property Value

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

beginDeleteGraphResourceAndWait

Warning

This API is now deprecated.

use deleteGraphResource instead

beginDeleteGraphResourceAndWait: (resourceGroupName: string, accountName: string, graphName: string, options?: GraphResourcesDeleteGraphResourceOptionalParams) => Promise<void>

Property Value

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

createUpdateGraph

Create or update an Azure Cosmos DB Graph.

createUpdateGraph: (resourceGroupName: string, accountName: string, graphName: string, createUpdateGraphParameters: GraphResourceCreateUpdateParameters, options?: GraphResourcesCreateUpdateGraphOptionalParams) => PollerLike<OperationState<GraphResourceGetResults>, GraphResourceGetResults>

Property Value

(resourceGroupName: string, accountName: string, graphName: string, createUpdateGraphParameters: GraphResourceCreateUpdateParameters, options?: GraphResourcesCreateUpdateGraphOptionalParams) => PollerLike<OperationState<GraphResourceGetResults>, GraphResourceGetResults>

deleteGraphResource

Deletes an existing Azure Cosmos DB Graph Resource.

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

Property Value

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

getGraph

Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.

getGraph: (resourceGroupName: string, accountName: string, graphName: string, options?: GraphResourcesGetGraphOptionalParams) => Promise<GraphResourceGetResults>

Property Value

(resourceGroupName: string, accountName: string, graphName: string, options?: GraphResourcesGetGraphOptionalParams) => Promise<GraphResourceGetResults>

listGraphs

Lists the graphs under an existing Azure Cosmos DB database account.

listGraphs: (resourceGroupName: string, accountName: string, options?: GraphResourcesListGraphsOptionalParams) => PagedAsyncIterableIterator<GraphResourceGetResults, GraphResourceGetResults[], PageSettings>

Property Value

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