Bookmarks interface

Interface representing a Bookmarks.

Methods

createOrUpdate(string, string, string, Bookmark, BookmarksCreateOrUpdateOptionalParams)

Creates or updates the bookmark.

delete(string, string, string, BookmarksDeleteOptionalParams)

Delete the bookmark.

get(string, string, string, BookmarksGetOptionalParams)

Gets a bookmark.

list(string, string, BookmarksListOptionalParams)

Gets all bookmarks.

Method Details

createOrUpdate(string, string, string, Bookmark, BookmarksCreateOrUpdateOptionalParams)

Creates or updates the bookmark.

function createOrUpdate(resourceGroupName: string, workspaceName: string, bookmarkId: string, bookmark: Bookmark, options?: BookmarksCreateOrUpdateOptionalParams): Promise<Bookmark>

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

bookmark
Bookmark

The bookmark

options
BookmarksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Bookmark>

delete(string, string, string, BookmarksDeleteOptionalParams)

Delete the bookmark.

function delete(resourceGroupName: string, workspaceName: string, bookmarkId: string, options?: BookmarksDeleteOptionalParams): 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

options
BookmarksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, BookmarksGetOptionalParams)

Gets a bookmark.

function get(resourceGroupName: string, workspaceName: string, bookmarkId: string, options?: BookmarksGetOptionalParams): Promise<Bookmark>

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
BookmarksGetOptionalParams

The options parameters.

Returns

Promise<Bookmark>

list(string, string, BookmarksListOptionalParams)

Gets all bookmarks.

function list(resourceGroupName: string, workspaceName: string, options?: BookmarksListOptionalParams): PagedAsyncIterableIterator<Bookmark, Bookmark[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options
BookmarksListOptionalParams

The options parameters.

Returns