ResourceLinks interface

Package:

@azure/arm-links

Interface representing a ResourceLinks.

Methods

createOrUpdate(string, ResourceLink, ResourceLinksCreateOrUpdateOptionalParams)	Creates or updates a resource link between the specified resources.
delete(string, ResourceLinksDeleteOptionalParams)	Deletes a resource link with the specified ID.
get(string, ResourceLinksGetOptionalParams)	Gets a resource link with the specified ID.
listAtSourceScope(string, ResourceLinksListAtSourceScopeOptionalParams)	Gets a list of resource links at and below the specified source scope.
listAtSubscription(ResourceLinksListAtSubscriptionOptionalParams)	Gets all the linked resources for the subscription.

Method Details

createOrUpdate(string, ResourceLink, ResourceLinksCreateOrUpdateOptionalParams)

Creates or updates a resource link between the specified resources.

function createOrUpdate(linkId: string, parameters: ResourceLink, options?: ResourceLinksCreateOrUpdateOptionalParams): Promise<ResourceLink>

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

ResourceLinksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ResourceLink>

delete(string, ResourceLinksDeleteOptionalParams)

Deletes a resource link with the specified ID.

function delete(linkId: string, options?: ResourceLinksDeleteOptionalParams): Promise<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

ResourceLinksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, ResourceLinksGetOptionalParams)

Gets a resource link with the specified ID.

function get(linkId: string, options?: ResourceLinksGetOptionalParams): Promise<ResourceLink>

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

ResourceLinksGetOptionalParams

The options parameters.

Returns

Promise<ResourceLink>

listAtSourceScope(string, ResourceLinksListAtSourceScopeOptionalParams)

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

function listAtSourceScope(scope: string, options?: ResourceLinksListAtSourceScopeOptionalParams): PagedAsyncIterableIterator<ResourceLink, ResourceLink[], PageSettings>

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 options parameters.

Returns

PagedAsyncIterableIterator<ResourceLink, ResourceLink[], PageSettings>

listAtSubscription(ResourceLinksListAtSubscriptionOptionalParams)

Gets all the linked resources for the subscription.

function listAtSubscription(options?: ResourceLinksListAtSubscriptionOptionalParams): PagedAsyncIterableIterator<ResourceLink, ResourceLink[], PageSettings>

Parameters

options

ResourceLinksListAtSubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceLink, ResourceLink[], PageSettings>