ServerCommunicationLinksOperations Class

ServerCommunicationLinksOperations 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

ServerCommunicationLinksOperations

Constructor

ServerCommunicationLinksOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

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.

begin_create_or_update(resource_group_name: str, server_name: str, communication_link_name: str, parameters: '_models.ServerCommunicationLink', **kwargs: Any) -> LROPoller['_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.
server_name Required	str The name of the server.
communication_link_name Required	str The name of the server communication link.
parameters Required	ServerCommunicationLink The required parameters for creating a server communication link.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

delete

Deletes a server communication link.

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.
server_name Required	str The name of the server.
communication_link_name Required	str The name of the server communication link.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Returns a server communication link.

get(resource_group_name: str, server_name: str, communication_link_name: str, **kwargs: Any) -> _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.
server_name Required	str The name of the server.
communication_link_name Required	str The name of the server communication link.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> Iterable['_models.ServerCommunicationLinkListResult']

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.
server_name Required	str The name of the server.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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