Metadata interface

Interface representing a Metadata.

Methods

create(string, string, string, MetadataModel, MetadataCreateOptionalParams)

Create a Metadata.

delete(string, string, string, MetadataDeleteOptionalParams)

Delete a Metadata.

get(string, string, string, MetadataGetOptionalParams)

Get a Metadata.

list(string, string, MetadataListOptionalParams)

List of all metadata

update(string, string, string, MetadataPatch, MetadataUpdateOptionalParams)

Update an existing Metadata.

Method Details

create(string, string, string, MetadataModel, MetadataCreateOptionalParams)

Create a Metadata.

function create(resourceGroupName: string, workspaceName: string, metadataName: string, metadata: MetadataModel, options?: MetadataCreateOptionalParams): Promise<MetadataModel>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

metadataName

string

The Metadata name.

metadata
MetadataModel

Metadata resource.

options
MetadataCreateOptionalParams

The options parameters.

Returns

Promise<MetadataModel>

delete(string, string, string, MetadataDeleteOptionalParams)

Delete a Metadata.

function delete(resourceGroupName: string, workspaceName: string, metadataName: string, options?: MetadataDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

metadataName

string

The Metadata name.

options
MetadataDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, MetadataGetOptionalParams)

Get a Metadata.

function get(resourceGroupName: string, workspaceName: string, metadataName: string, options?: MetadataGetOptionalParams): Promise<MetadataModel>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

metadataName

string

The Metadata name.

options
MetadataGetOptionalParams

The options parameters.

Returns

Promise<MetadataModel>

list(string, string, MetadataListOptionalParams)

List of all metadata

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options
MetadataListOptionalParams

The options parameters.

Returns

update(string, string, string, MetadataPatch, MetadataUpdateOptionalParams)

Update an existing Metadata.

function update(resourceGroupName: string, workspaceName: string, metadataName: string, metadataPatch: MetadataPatch, options?: MetadataUpdateOptionalParams): Promise<MetadataModel>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

metadataName

string

The Metadata name.

metadataPatch
MetadataPatch

Partial metadata request.

options
MetadataUpdateOptionalParams

The options parameters.

Returns

Promise<MetadataModel>