ServerCommunicationLinksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:server_communication_links> attribute.

Constructor

ServerCommunicationLinksOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a server communication link.
delete	Deletes a server communication link.
get	Returns a server communication link.
list_by_server	Gets a list of server communication links.

begin_create_or_update

Creates a server communication link.

async begin_create_or_update(resource_group_name: str, server_name: str, communication_link_name: str, parameters: _models.ServerCommunicationLink, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ServerCommunicationLink]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
communication_link_name Required	str The name of the server communication link. Required.
parameters Required	ServerCommunicationLink or IO[bytes] The required parameters for creating a server communication link. Is either a ServerCommunicationLink type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ServerCommunicationLink]	An instance of AsyncLROPoller that returns either ServerCommunicationLink or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a server communication link.

async delete(resource_group_name: str, server_name: str, communication_link_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
communication_link_name Required	str The name of the server communication link. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Returns a server communication link.

async get(resource_group_name: str, server_name: str, communication_link_name: str, **kwargs: Any) -> ServerCommunicationLink

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
communication_link_name Required	str The name of the server communication link. Required.

Returns

Type	Description
ServerCommunicationLink	ServerCommunicationLink or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_server

Gets a list of server communication links.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncItemPaged[ServerCommunicationLink]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.

Returns

Type	Description
AsyncItemPaged[ServerCommunicationLink]	An iterator like instance of either ServerCommunicationLink or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>