BookmarkRelations interface

Interface representing a BookmarkRelations.

Methods

createOrUpdate(string, string, string, string, Relation, BookmarkRelationsCreateOrUpdateOptionalParams)

Creates the bookmark relation.

delete(string, string, string, string, BookmarkRelationsDeleteOptionalParams)

Delete the bookmark relation.

get(string, string, string, string, BookmarkRelationsGetOptionalParams)

Gets a bookmark relation.

list(string, string, string, BookmarkRelationsListOptionalParams)

Gets all bookmark relations.

Method Details

createOrUpdate(string, string, string, string, Relation, BookmarkRelationsCreateOrUpdateOptionalParams)

Creates the bookmark relation.

function createOrUpdate(resourceGroupName: string, workspaceName: string, bookmarkId: string, relationName: string, relation: Relation, options?: BookmarkRelationsCreateOrUpdateOptionalParams): Promise<Relation>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

bookmarkId

string

Bookmark ID

relationName

string

Relation Name

relation
Relation

The relation model

options
BookmarkRelationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Relation>

delete(string, string, string, string, BookmarkRelationsDeleteOptionalParams)

Delete the bookmark relation.

function delete(resourceGroupName: string, workspaceName: string, bookmarkId: string, relationName: string, options?: BookmarkRelationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

bookmarkId

string

Bookmark ID

relationName

string

Relation Name

options
BookmarkRelationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, BookmarkRelationsGetOptionalParams)

Gets a bookmark relation.

function get(resourceGroupName: string, workspaceName: string, bookmarkId: string, relationName: string, options?: BookmarkRelationsGetOptionalParams): Promise<Relation>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

bookmarkId

string

Bookmark ID

relationName

string

Relation Name

options
BookmarkRelationsGetOptionalParams

The options parameters.

Returns

Promise<Relation>

list(string, string, string, BookmarkRelationsListOptionalParams)

Gets all bookmark relations.

function list(resourceGroupName: string, workspaceName: string, bookmarkId: string, options?: BookmarkRelationsListOptionalParams): PagedAsyncIterableIterator<Relation, Relation[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

bookmarkId

string

Bookmark ID

options
BookmarkRelationsListOptionalParams

The options parameters.

Returns