Labels interface

Interface representing a Labels.

Methods

beginCreateAndUpdate(string, string, string, LabelsCreateAndUpdateOptionalParams)

Create or update a Label.

beginCreateAndUpdateAndWait(string, string, string, LabelsCreateAndUpdateOptionalParams)

Create or update a Label.

beginDelete(string, string, string, LabelsDeleteOptionalParams)

Delete a Label.

beginDeleteAndWait(string, string, string, LabelsDeleteOptionalParams)

Delete a Label.

getByWorkspace(string, string, string, LabelsGetByWorkspaceOptionalParams)

Returns a label in the given workspace.

listByWorkspace(string, string, LabelsListByWorkspaceOptionalParams)

Returns a list of labels in the given workspace.

update(string, string, string, LabelsUpdateOptionalParams)

Update a Label.

Method Details

beginCreateAndUpdate(string, string, string, LabelsCreateAndUpdateOptionalParams)

Create or update a Label.

function beginCreateAndUpdate(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsCreateAndUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LabelResource>, LabelResource>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the Workspace.

labelName

string

The name of the Label.

options
LabelsCreateAndUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<LabelResource>, LabelResource>>

beginCreateAndUpdateAndWait(string, string, string, LabelsCreateAndUpdateOptionalParams)

Create or update a Label.

function beginCreateAndUpdateAndWait(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsCreateAndUpdateOptionalParams): Promise<LabelResource>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the Workspace.

labelName

string

The name of the Label.

options
LabelsCreateAndUpdateOptionalParams

The options parameters.

Returns

Promise<LabelResource>

beginDelete(string, string, string, LabelsDeleteOptionalParams)

Delete a Label.

function beginDelete(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the Workspace.

labelName

string

The name of the Label.

options
LabelsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, LabelsDeleteOptionalParams)

Delete a Label.

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the Workspace.

labelName

string

The name of the Label.

options
LabelsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

getByWorkspace(string, string, string, LabelsGetByWorkspaceOptionalParams)

Returns a label in the given workspace.

function getByWorkspace(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsGetByWorkspaceOptionalParams): Promise<LabelResource>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the Workspace.

labelName

string

The name of the Label.

options
LabelsGetByWorkspaceOptionalParams

The options parameters.

Returns

Promise<LabelResource>

listByWorkspace(string, string, LabelsListByWorkspaceOptionalParams)

Returns a list of labels in the given workspace.

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: LabelsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<LabelResource, LabelResource[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the Workspace.

options
LabelsListByWorkspaceOptionalParams

The options parameters.

Returns

update(string, string, string, LabelsUpdateOptionalParams)

Update a Label.

function update(resourceGroupName: string, workspaceName: string, labelName: string, options?: LabelsUpdateOptionalParams): Promise<LabelResource>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the Workspace.

labelName

string

The name of the Label.

options
LabelsUpdateOptionalParams

The options parameters.

Returns

Promise<LabelResource>