GraphResources | @azure/arm-cosmosdb

Interface representing a GraphResources.

Hierarchy

GraphResources

Implemented by

GraphResourcesImpl

Index

Methods

beginCreateUpdateGraph

beginCreateUpdateGraph(resourceGroupName: string, accountName: string, graphName: string, createUpdateGraphParameters: GraphResourceCreateUpdateParameters, options?: GraphResourcesCreateUpdateGraphOptionalParams): Promise<PollerLike<PollOperationState<GraphResourcesCreateUpdateGraphResponse>, GraphResourcesCreateUpdateGraphResponse>>

- Defined in operationsInterfaces/graphResources.ts:57
Create or update an Azure Cosmos DB Graph.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- graphName: string
  
  Cosmos DB graph resource name.
- createUpdateGraphParameters: GraphResourceCreateUpdateParameters
  
  The parameters to provide for the current graph.
- Optional options: GraphResourcesCreateUpdateGraphOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GraphResourcesCreateUpdateGraphResponse>, GraphResourcesCreateUpdateGraphResponse>>

beginCreateUpdateGraphAndWait

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

- Defined in operationsInterfaces/graphResources.ts:77
Create or update an Azure Cosmos DB Graph.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- graphName: string
  
  Cosmos DB graph resource name.
- createUpdateGraphParameters: GraphResourceCreateUpdateParameters
  
  The parameters to provide for the current graph.
- Optional options: GraphResourcesCreateUpdateGraphOptionalParams
  
  The options parameters.
Returns Promise<GraphResourcesCreateUpdateGraphResponse>

beginDeleteGraphResource

beginDeleteGraphResource(resourceGroupName: string, accountName: string, graphName: string, options?: GraphResourcesDeleteGraphResourceOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/graphResources.ts:91
Deletes an existing Azure Cosmos DB Graph Resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- graphName: string
  
  Cosmos DB graph resource name.
- Optional options: GraphResourcesDeleteGraphResourceOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteGraphResourceAndWait

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

- Defined in operationsInterfaces/graphResources.ts:104
Deletes an existing Azure Cosmos DB Graph Resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- graphName: string
  
  Cosmos DB graph resource name.
- Optional options: GraphResourcesDeleteGraphResourceOptionalParams
  
  The options parameters.
Returns Promise<void>

getGraph

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

- Defined in operationsInterfaces/graphResources.ts:43
Gets the Graph resource under an existing Azure Cosmos DB database account with the provided name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- graphName: string
  
  Cosmos DB graph resource name.
- Optional options: GraphResourcesGetGraphOptionalParams
  
  The options parameters.
Returns Promise<GraphResourcesGetGraphResponse>

listGraphs

listGraphs(resourceGroupName: string, accountName: string, options?: GraphResourcesListGraphsOptionalParams): PagedAsyncIterableIterator<GraphResourceGetResults>

- Defined in operationsInterfaces/graphResources.ts:31
Lists the graphs under an existing Azure Cosmos DB database account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: GraphResourcesListGraphsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GraphResourceGetResults>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateUpdateGraph

Parameters

resourceGroupName: string

accountName: string

graphName: string

createUpdateGraphParameters: GraphResourceCreateUpdateParameters

Optional options: GraphResourcesCreateUpdateGraphOptionalParams

Returns Promise<PollerLike<PollOperationState<GraphResourcesCreateUpdateGraphResponse>, GraphResourcesCreateUpdateGraphResponse>>

beginCreateUpdateGraphAndWait

Parameters

resourceGroupName: string

accountName: string

graphName: string

createUpdateGraphParameters: GraphResourceCreateUpdateParameters

Optional options: GraphResourcesCreateUpdateGraphOptionalParams

Returns Promise<GraphResourcesCreateUpdateGraphResponse>

beginDeleteGraphResource

Parameters

resourceGroupName: string

accountName: string

graphName: string

Optional options: GraphResourcesDeleteGraphResourceOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteGraphResourceAndWait

Parameters

resourceGroupName: string

accountName: string

graphName: string

Optional options: GraphResourcesDeleteGraphResourceOptionalParams

Returns Promise<void>

getGraph

Parameters

resourceGroupName: string

accountName: string

graphName: string

Optional options: GraphResourcesGetGraphOptionalParams

Returns Promise<GraphResourcesGetGraphResponse>

listGraphs

Parameters

resourceGroupName: string

accountName: string

Optional options: GraphResourcesListGraphsOptionalParams

Returns PagedAsyncIterableIterator<GraphResourceGetResults>