Relationships interface

Package:

@azure/arm-customerinsights

Interface representing a Relationships.

Methods

beginCreateOrUpdate(string, string, string, RelationshipResourceFormat, RelationshipsCreateOrUpdateOptionalParams)	Creates a relationship or updates an existing relationship within a hub.
beginCreateOrUpdateAndWait(string, string, string, RelationshipResourceFormat, RelationshipsCreateOrUpdateOptionalParams)	Creates a relationship or updates an existing relationship within a hub.
beginDelete(string, string, string, RelationshipsDeleteOptionalParams)	Deletes a relationship within a hub.
beginDeleteAndWait(string, string, string, RelationshipsDeleteOptionalParams)	Deletes a relationship within a hub.
get(string, string, string, RelationshipsGetOptionalParams)	Gets information about the specified relationship.
listByHub(string, string, RelationshipsListByHubOptionalParams)	Gets all relationships in the hub.

Method Details

beginCreateOrUpdate(string, string, string, RelationshipResourceFormat, RelationshipsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, hubName: string, relationshipName: string, parameters: RelationshipResourceFormat, options?: RelationshipsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<RelationshipResourceFormat>, RelationshipResourceFormat>>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipName

string

The name of the Relationship.

parameters

RelationshipResourceFormat

Parameters supplied to the CreateOrUpdate Relationship operation.

options

RelationshipsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, RelationshipResourceFormat, RelationshipsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, hubName: string, relationshipName: string, parameters: RelationshipResourceFormat, options?: RelationshipsCreateOrUpdateOptionalParams): Promise<RelationshipResourceFormat>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipName

string

The name of the Relationship.

parameters

RelationshipResourceFormat

Parameters supplied to the CreateOrUpdate Relationship operation.

options

RelationshipsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RelationshipResourceFormat>

beginDelete(string, string, string, RelationshipsDeleteOptionalParams)

Deletes a relationship within a hub.

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

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipName

string

The name of the relationship.

options

RelationshipsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, RelationshipsDeleteOptionalParams)

Deletes a relationship within a hub.

function beginDeleteAndWait(resourceGroupName: string, hubName: string, relationshipName: string, options?: RelationshipsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipName

string

The name of the relationship.

options

RelationshipsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, RelationshipsGetOptionalParams)

Gets information about the specified relationship.

function get(resourceGroupName: string, hubName: string, relationshipName: string, options?: RelationshipsGetOptionalParams): Promise<RelationshipResourceFormat>

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

relationshipName

string

The name of the relationship.

options

RelationshipsGetOptionalParams

The options parameters.

Returns

Promise<RelationshipResourceFormat>

listByHub(string, string, RelationshipsListByHubOptionalParams)

Gets all relationships in the hub.

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

Parameters

resourceGroupName

string

The name of the resource group.

hubName

string

The name of the hub.

options

RelationshipsListByHubOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RelationshipResourceFormat, RelationshipResourceFormat[], PageSettings>