Linker interface

Interface representing a Linker.

Methods

beginCreateOrUpdate(string, string, LinkerResource, LinkerCreateOrUpdateOptionalParams)

Create or update linker resource.

beginCreateOrUpdateAndWait(string, string, LinkerResource, LinkerCreateOrUpdateOptionalParams)

Create or update linker resource.

beginDelete(string, string, LinkerDeleteOptionalParams)

Delete a link.

beginDeleteAndWait(string, string, LinkerDeleteOptionalParams)

Delete a link.

beginUpdate(string, string, LinkerPatch, LinkerUpdateOptionalParams)

Operation to update an existing link.

beginUpdateAndWait(string, string, LinkerPatch, LinkerUpdateOptionalParams)

Operation to update an existing link.

beginValidate(string, string, LinkerValidateOptionalParams)

Validate a link.

beginValidateAndWait(string, string, LinkerValidateOptionalParams)

Validate a link.

get(string, string, LinkerGetOptionalParams)

Returns Linker resource for a given name.

list(string, LinkerListOptionalParams)

Returns list of Linkers which connects to the resource.

listConfigurations(string, string, LinkerListConfigurationsOptionalParams)

list source configurations for a linker.

Method Details

beginCreateOrUpdate(string, string, LinkerResource, LinkerCreateOrUpdateOptionalParams)

Create or update linker resource.

function beginCreateOrUpdate(resourceUri: string, linkerName: string, parameters: LinkerResource, options?: LinkerCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<LinkerResource>, LinkerResource>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

parameters
LinkerResource

Linker details.

options
LinkerCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<LinkerResource>, LinkerResource>>

beginCreateOrUpdateAndWait(string, string, LinkerResource, LinkerCreateOrUpdateOptionalParams)

Create or update linker resource.

function beginCreateOrUpdateAndWait(resourceUri: string, linkerName: string, parameters: LinkerResource, options?: LinkerCreateOrUpdateOptionalParams): Promise<LinkerResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

parameters
LinkerResource

Linker details.

options
LinkerCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LinkerResource>

beginDelete(string, string, LinkerDeleteOptionalParams)

Delete a link.

function beginDelete(resourceUri: string, linkerName: string, options?: LinkerDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

options
LinkerDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, LinkerDeleteOptionalParams)

Delete a link.

function beginDeleteAndWait(resourceUri: string, linkerName: string, options?: LinkerDeleteOptionalParams): Promise<void>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

options
LinkerDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, LinkerPatch, LinkerUpdateOptionalParams)

Operation to update an existing link.

function beginUpdate(resourceUri: string, linkerName: string, parameters: LinkerPatch, options?: LinkerUpdateOptionalParams): Promise<PollerLike<PollOperationState<LinkerResource>, LinkerResource>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

parameters
LinkerPatch

Linker details.

options
LinkerUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<LinkerResource>, LinkerResource>>

beginUpdateAndWait(string, string, LinkerPatch, LinkerUpdateOptionalParams)

Operation to update an existing link.

function beginUpdateAndWait(resourceUri: string, linkerName: string, parameters: LinkerPatch, options?: LinkerUpdateOptionalParams): Promise<LinkerResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

parameters
LinkerPatch

Linker details.

options
LinkerUpdateOptionalParams

The options parameters.

Returns

Promise<LinkerResource>

beginValidate(string, string, LinkerValidateOptionalParams)

Validate a link.

function beginValidate(resourceUri: string, linkerName: string, options?: LinkerValidateOptionalParams): Promise<PollerLike<PollOperationState<ValidateOperationResult>, ValidateOperationResult>>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

options
LinkerValidateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ValidateOperationResult>, ValidateOperationResult>>

beginValidateAndWait(string, string, LinkerValidateOptionalParams)

Validate a link.

function beginValidateAndWait(resourceUri: string, linkerName: string, options?: LinkerValidateOptionalParams): Promise<ValidateOperationResult>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

options
LinkerValidateOptionalParams

The options parameters.

Returns

get(string, string, LinkerGetOptionalParams)

Returns Linker resource for a given name.

function get(resourceUri: string, linkerName: string, options?: LinkerGetOptionalParams): Promise<LinkerResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

options
LinkerGetOptionalParams

The options parameters.

Returns

Promise<LinkerResource>

list(string, LinkerListOptionalParams)

Returns list of Linkers which connects to the resource.

function list(resourceUri: string, options?: LinkerListOptionalParams): PagedAsyncIterableIterator<LinkerResource, LinkerResource[], PageSettings>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

options
LinkerListOptionalParams

The options parameters.

Returns

listConfigurations(string, string, LinkerListConfigurationsOptionalParams)

list source configurations for a linker.

function listConfigurations(resourceUri: string, linkerName: string, options?: LinkerListConfigurationsOptionalParams): Promise<SourceConfigurationResult>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

linkerName

string

The name Linker resource.

options
LinkerListConfigurationsOptionalParams

The options parameters.

Returns