RelationshipLinks interface

Package:

@azure/arm-customerinsights

Interface representing a RelationshipLinks.

Methods

beginCreateOrUpdate(string, string, string, RelationshipLinkResourceFormat, RelationshipLinksCreateOrUpdateOptionalParams)	Creates a relationship link or updates an existing relationship link within a hub.
beginCreateOrUpdateAndWait(string, string, string, RelationshipLinkResourceFormat, RelationshipLinksCreateOrUpdateOptionalParams)	Creates a relationship link or updates an existing relationship link within a hub.
beginDelete(string, string, string, RelationshipLinksDeleteOptionalParams)	Deletes a relationship link within a hub.
beginDeleteAndWait(string, string, string, RelationshipLinksDeleteOptionalParams)	Deletes a relationship link within a hub.
get(string, string, string, RelationshipLinksGetOptionalParams)	Gets information about the specified relationship Link.
listByHub(string, string, RelationshipLinksListByHubOptionalParams)	Gets all relationship links in the hub.

Method Details

beginCreateOrUpdate(string, string, string, RelationshipLinkResourceFormat, RelationshipLinksCreateOrUpdateOptionalParams)

Creates a relationship link or updates an existing relationship link within a hub.

function beginCreateOrUpdate(resourceGroupName: string, hubName: string, relationshipLinkName: string, parameters: RelationshipLinkResourceFormat, options?: RelationshipLinksCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<RelationshipLinkResourceFormat>, RelationshipLinkResourceFormat>>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipLinkName

string

The name of the relationship link.

parameters

RelationshipLinkResourceFormat

Parameters supplied to the CreateOrUpdate relationship link operation.

options

RelationshipLinksCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, RelationshipLinkResourceFormat, RelationshipLinksCreateOrUpdateOptionalParams)

Creates a relationship link or updates an existing relationship link within a hub.

function beginCreateOrUpdateAndWait(resourceGroupName: string, hubName: string, relationshipLinkName: string, parameters: RelationshipLinkResourceFormat, options?: RelationshipLinksCreateOrUpdateOptionalParams): Promise<RelationshipLinkResourceFormat>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipLinkName

string

The name of the relationship link.

parameters

RelationshipLinkResourceFormat

Parameters supplied to the CreateOrUpdate relationship link operation.

options

RelationshipLinksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RelationshipLinkResourceFormat>

beginDelete(string, string, string, RelationshipLinksDeleteOptionalParams)

Deletes a relationship link within a hub.

function beginDelete(resourceGroupName: string, hubName: string, relationshipLinkName: string, options?: RelationshipLinksDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipLinkName

string

The name of the relationship.

options

RelationshipLinksDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, RelationshipLinksDeleteOptionalParams)

Deletes a relationship link within a hub.

function beginDeleteAndWait(resourceGroupName: string, hubName: string, relationshipLinkName: string, options?: RelationshipLinksDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipLinkName

string

The name of the relationship.

options

RelationshipLinksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, RelationshipLinksGetOptionalParams)

Gets information about the specified relationship Link.

function get(resourceGroupName: string, hubName: string, relationshipLinkName: string, options?: RelationshipLinksGetOptionalParams): Promise<RelationshipLinkResourceFormat>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipLinkName

string

The name of the relationship link.

options

RelationshipLinksGetOptionalParams

The options parameters.

Returns

Promise<RelationshipLinkResourceFormat>

listByHub(string, string, RelationshipLinksListByHubOptionalParams)

Gets all relationship links in the hub.

function listByHub(resourceGroupName: string, hubName: string, options?: RelationshipLinksListByHubOptionalParams): PagedAsyncIterableIterator<RelationshipLinkResourceFormat, RelationshipLinkResourceFormat[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

options

RelationshipLinksListByHubOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RelationshipLinkResourceFormat, RelationshipLinkResourceFormat[], PageSettings>