Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Relationships

Package version

Class representing a Relationships.

Hierarchy

  • Relationships

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, hubName: string, relationshipName: string, parameters: RelationshipResourceFormat, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

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

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, hubName: string, relationshipName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes a relationship within a hub.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • hubName: string

      The name of the hub.

    • relationshipName: string

      The name of the relationship.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, hubName: string, relationshipName: string, parameters: RelationshipResourceFormat, options?: msRest.RequestOptionsBase): Promise<Models.RelationshipsCreateOrUpdateResponse>

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

    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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RelationshipsCreateOrUpdateResponse>

    Promise<Models.RelationshipsCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, hubName: string, relationshipName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deletes a relationship within a hub.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • hubName: string

      The name of the hub.

    • relationshipName: string

      The name of the relationship.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, hubName: string, relationshipName: string, options?: msRest.RequestOptionsBase): Promise<Models.RelationshipsGetResponse>
  • get(resourceGroupName: string, hubName: string, relationshipName: string, callback: msRest.ServiceCallback<RelationshipResourceFormat>): void
  • get(resourceGroupName: string, hubName: string, relationshipName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelationshipResourceFormat>): void

  • Gets information about the specified relationship.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • hubName: string

      The name of the hub.

    • relationshipName: string

      The name of the relationship.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RelationshipsGetResponse>

    Promise<Models.RelationshipsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • hubName: string

      The name of the hub.

    • relationshipName: string

      The name of the relationship.

    • callback: msRest.ServiceCallback<RelationshipResourceFormat>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelationshipResourceFormat>

      The callback

    Returns void

listByHub

  • listByHub(resourceGroupName: string, hubName: string, options?: msRest.RequestOptionsBase): Promise<Models.RelationshipsListByHubResponse>
  • listByHub(resourceGroupName: string, hubName: string, callback: msRest.ServiceCallback<RelationshipListResult>): void
  • listByHub(resourceGroupName: string, hubName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelationshipListResult>): void

  • Gets all relationships in the hub.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • hubName: string

      The name of the hub.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RelationshipsListByHubResponse>

    Promise<Models.RelationshipsListByHubResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • hubName: string

      The name of the hub.

    • callback: msRest.ServiceCallback<RelationshipListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • hubName: string

      The name of the hub.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelationshipListResult>

      The callback

    Returns void

listByHubNext

  • listByHubNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.RelationshipsListByHubNextResponse>
  • listByHubNext(nextPageLink: string, callback: msRest.ServiceCallback<RelationshipListResult>): void
  • listByHubNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RelationshipListResult>): void

  • Gets all relationships in the hub.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RelationshipsListByHubNextResponse>

    Promise<Models.RelationshipsListByHubNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RelationshipListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<RelationshipListResult>

      The callback

    Returns void

Generated using TypeDoc