Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ResourceLinks

Package version

Class representing a ResourceLinks.

Hierarchy

  • ResourceLinks

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(linkId: string, parameters: ResourceLink, options?: msRest.RequestOptionsBase): Promise<Models.ResourceLinksCreateOrUpdateResponse>
  • createOrUpdate(linkId: string, parameters: ResourceLink, callback: msRest.ServiceCallback<ResourceLink>): void
  • createOrUpdate(linkId: string, parameters: ResourceLink, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceLink>): void

  • Creates or updates a resource link between the specified resources.

    Parameters

    • linkId: string

      The fully qualified ID of the resource link. Use the format, /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name}. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • parameters: ResourceLink

      Parameters for creating or updating a resource link.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceLinksCreateOrUpdateResponse>

    Promise<Models.ResourceLinksCreateOrUpdateResponse>

  • Parameters

    • linkId: string

      The fully qualified ID of the resource link. Use the format, /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name}. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • parameters: ResourceLink

      Parameters for creating or updating a resource link.

    • callback: msRest.ServiceCallback<ResourceLink>

      The callback

    Returns void

  • Parameters

    • linkId: string

      The fully qualified ID of the resource link. Use the format, /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name}. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • parameters: ResourceLink

      Parameters for creating or updating a resource link.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceLink>

      The callback

    Returns void

deleteMethod

  • deleteMethod(linkId: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(linkId: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(linkId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a resource link with the specified ID.

    Parameters

    • linkId: string

      The fully qualified ID of the resource link. Use the format, /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name}. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • linkId: string

      The fully qualified ID of the resource link. Use the format, /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name}. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • linkId: string

      The fully qualified ID of the resource link. Use the format, /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/{provider-namespace}/{resource-type}/{resource-name}/Microsoft.Resources/links/{link-name}. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(linkId: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceLinksGetResponse>
  • get(linkId: string, callback: msRest.ServiceCallback<ResourceLink>): void
  • get(linkId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceLink>): void

  • Gets a resource link with the specified ID.

    Parameters

    • linkId: string

      The fully qualified Id of the resource link. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceLinksGetResponse>

    Promise<Models.ResourceLinksGetResponse>

  • Parameters

    • linkId: string

      The fully qualified Id of the resource link. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • callback: msRest.ServiceCallback<ResourceLink>

      The callback

    Returns void

  • Parameters

    • linkId: string

      The fully qualified Id of the resource link. For example, /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup/Microsoft.Web/sites/mySite/Microsoft.Resources/links/myLink

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceLink>

      The callback

    Returns void

listAtSourceScope

  • Gets a list of resource links at and below the specified source scope.

    Parameters

    • scope: string

      The fully qualified ID of the scope for getting the resource links. For example, to list resource links at and under a resource group, set the scope to /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup.

    • Optional options: Models.ResourceLinksListAtSourceScopeOptionalParams

    Returns Promise<Models.ResourceLinksListAtSourceScopeResponse>

    Promise<Models.ResourceLinksListAtSourceScopeResponse>

  • Parameters

    • scope: string

      The fully qualified ID of the scope for getting the resource links. For example, to list resource links at and under a resource group, set the scope to /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup.

    • callback: msRest.ServiceCallback<ResourceLinkResult>

      The callback

    Returns void

  • Parameters

    • scope: string

      The fully qualified ID of the scope for getting the resource links. For example, to list resource links at and under a resource group, set the scope to /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myGroup.

    • options: ResourceLinksListAtSourceScopeOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<ResourceLinkResult>

      The callback

    Returns void

listAtSourceScopeNext

  • listAtSourceScopeNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceLinksListAtSourceScopeNextResponse>
  • listAtSourceScopeNext(nextPageLink: string, callback: msRest.ServiceCallback<ResourceLinkResult>): void
  • listAtSourceScopeNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceLinkResult>): void

  • Gets a list of resource links at and below the specified source scope.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceLinksListAtSourceScopeNextResponse>

    Promise<Models.ResourceLinksListAtSourceScopeNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ResourceLinkResult>

      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<ResourceLinkResult>

      The callback

    Returns void

listAtSubscription

listAtSubscriptionNext

  • listAtSubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceLinksListAtSubscriptionNextResponse>
  • listAtSubscriptionNext(nextPageLink: string, callback: msRest.ServiceCallback<ResourceLinkResult>): void
  • listAtSubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ResourceLinkResult>): void

  • Gets all the linked resources for the subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ResourceLinksListAtSubscriptionNextResponse>

    Promise<Models.ResourceLinksListAtSubscriptionNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ResourceLinkResult>

      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<ResourceLinkResult>

      The callback

    Returns void

Generated using TypeDoc