LinkedServerOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

RedisManagementClient's

<xref:linked_server> attribute.

Inheritance
builtins.object
LinkedServerOperations

Constructor

LinkedServerOperations(*args, **kwargs)

Methods

begin_create

Adds a linked server to the Redis cache (requires Premium SKU).
begin_delete

Deletes the linked server from a redis cache (requires Premium SKU).
get

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).
list

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

begin_create

Adds a linked server to the Redis cache (requires Premium SKU).

begin_create(resource_group_name: str, name: str, linked_server_name: str, parameters: _models.RedisLinkedServerCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.RedisLinkedServerWithProperties]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the Redis cache. Required.
linked_server_name
Required
str

The name of the linked server that is being added to the Redis cache. Required.
parameters
Required
RedisLinkedServerCreateParameters or IO[bytes]

Parameters supplied to the Create Linked server operation. Is either a RedisLinkedServerCreateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[RedisLinkedServerWithProperties]

An instance of LROPoller that returns either RedisLinkedServerWithProperties or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the linked server from a redis cache (requires Premium SKU).

begin_delete(resource_group_name: str, name: str, linked_server_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the redis cache. Required.
linked_server_name
Required
str

The name of the linked server that is being added to the Redis cache. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

get(resource_group_name: str, name: str, linked_server_name: str, **kwargs: Any) -> RedisLinkedServerWithProperties

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the redis cache. Required.
linked_server_name
Required
str

The name of the linked server. Required.

Returns

Type Description
RedisLinkedServerWithProperties

RedisLinkedServerWithProperties or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

list(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[RedisLinkedServerWithProperties]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
name
Required
str

The name of the redis cache. Required.

Returns

Type Description
ItemPaged[RedisLinkedServerWithProperties]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.redis.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\redis\\models\\__init__.py'>