ResourceLinksOperations Class

ResourceLinksOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ResourceLinksOperations

Constructor

ResourceLinksOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_or_update	Creates or updates a resource link between the specified resources.
delete	Deletes a resource link with the specified ID.
get	Gets a resource link with the specified ID.
list_at_source_scope	Gets a list of resource links at and below the specified source scope.
list_at_subscription	Gets all the linked resources for the subscription.

create_or_update

Creates or updates a resource link between the specified resources.

async create_or_update(link_id: str, parameters: azure.mgmt.resource.links.v2016_09_01.models._models_py3.ResourceLink, **kwargs: Any) -> azure.mgmt.resource.links.v2016_09_01.models._models_py3.ResourceLink

Parameters

link_id

str

Required

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

Required

Parameters for creating or updating a resource link.

cls

callable

A custom type or function that will be passed the direct response

Returns

ResourceLink, or the result of cls(response)

Return type

ResourceLink

Exceptions

HttpResponseError

delete

Deletes a resource link with the specified ID.

async delete(link_id: str, **kwargs: Any) -> None

Parameters

link_id

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets a resource link with the specified ID.

async get(link_id: str, **kwargs: Any) -> azure.mgmt.resource.links.v2016_09_01.models._models_py3.ResourceLink

Parameters

link_id

str

Required

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

ResourceLink, or the result of cls(response)

Return type

ResourceLink

Exceptions

HttpResponseError

list_at_source_scope

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

list_at_source_scope(scope: str, filter: Optional[str] = 'atScope()', **kwargs: Any) -> AsyncIterable[azure.mgmt.resource.links.v2016_09_01.models._models_py3.ResourceLinkResult]

Parameters

scope

str

Required

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.

filter

str

Required

The filter to apply when getting resource links. To get links only at the specified scope (not below the scope), use Filter.atScope(). Possible values are "atScope()" or None. Default value is "atScope()".

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ResourceLinkResult or the result of cls(response)

Return type

AsyncItemPaged[ResourceLinkResult]

Exceptions

HttpResponseError

list_at_subscription

Gets all the linked resources for the subscription.

list_at_subscription(filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.resource.links.v2016_09_01.models._models_py3.ResourceLinkResult]

Parameters

filter

str

Required

The filter to apply on the list resource links operation. The supported filter for list resource links is targetId. For example, $filter=targetId eq {value}. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ResourceLinkResult or the result of cls(response)

Return type

AsyncItemPaged[ResourceLinkResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.resource.links.v2016_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\resource\\links\\v2016_09_01\\models\\__init__.py'>