Linker interface

Package:

@azure/arm-servicelinker

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 Linker.
beginDeleteAndWait(string, string, LinkerDeleteOptionalParams)	Delete a Linker.
beginUpdate(string, string, LinkerPatch, LinkerUpdateOptionalParams)	Operation to update an existing Linker.
beginUpdateAndWait(string, string, LinkerPatch, LinkerUpdateOptionalParams)	Operation to update an existing Linker.
beginValidate(string, string, LinkerValidateOptionalParams)	Validate a Linker.
beginValidateAndWait(string, string, LinkerValidateOptionalParams)	Validate a Linker.
get(string, string, LinkerGetOptionalParams)	Returns Linker resource for a given name.
list(string, LinkerListOptionalParams)	Returns list of Linkers which connects to the resource. which supports to config both application and target service during the resource provision.
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<SimplePollerLike<OperationState<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<@azure/core-lro.SimplePollerLike<OperationState<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 Linker.

function beginDelete(resourceUri: string, linkerName: string, options?: LinkerDeleteOptionalParams): Promise<SimplePollerLike<OperationState<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<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, LinkerDeleteOptionalParams)

Delete a Linker.

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 Linker.

function beginUpdate(resourceUri: string, linkerName: string, parameters: LinkerPatch, options?: LinkerUpdateOptionalParams): Promise<SimplePollerLike<OperationState<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<@azure/core-lro.SimplePollerLike<OperationState<LinkerResource>, LinkerResource>>

beginUpdateAndWait(string, string, LinkerPatch, LinkerUpdateOptionalParams)

Operation to update an existing Linker.

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 Linker.

function beginValidate(resourceUri: string, linkerName: string, options?: LinkerValidateOptionalParams): Promise<SimplePollerLike<OperationState<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<@azure/core-lro.SimplePollerLike<OperationState<ValidateOperationResult>, ValidateOperationResult>>

beginValidateAndWait(string, string, LinkerValidateOptionalParams)

Validate a Linker.

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

Promise<ValidateOperationResult>

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. which supports to config both application and target service during the resource provision.

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

PagedAsyncIterableIterator<LinkerResource, LinkerResource[], PageSettings>

listConfigurations(string, string, LinkerListConfigurationsOptionalParams)

list source configurations for a Linker.

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

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

Promise<ConfigurationResult>