ServerCommunicationLinks interface

Interface representing a ServerCommunicationLinks.

Methods

beginCreateOrUpdate(string, string, string, ServerCommunicationLink, ServerCommunicationLinksCreateOrUpdateOptionalParams)

Creates a server communication link.

beginCreateOrUpdateAndWait(string, string, string, ServerCommunicationLink, ServerCommunicationLinksCreateOrUpdateOptionalParams)

Creates a server communication link.

delete(string, string, string, ServerCommunicationLinksDeleteOptionalParams)

Deletes a server communication link.

get(string, string, string, ServerCommunicationLinksGetOptionalParams)

Returns a server communication link.

listByServer(string, string, ServerCommunicationLinksListByServerOptionalParams)

Gets a list of server communication links.

Method Details

Creates a server communication link.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, communicationLinkName: string, parameters: ServerCommunicationLink, options?: ServerCommunicationLinksCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServerCommunicationLink>, ServerCommunicationLink>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

communicationLinkName

string

The name of the server communication link.

parameters
ServerCommunicationLink

The required parameters for creating a server communication link.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServerCommunicationLink>, ServerCommunicationLink>>

Creates a server communication link.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, communicationLinkName: string, parameters: ServerCommunicationLink, options?: ServerCommunicationLinksCreateOrUpdateOptionalParams): Promise<ServerCommunicationLink>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

communicationLinkName

string

The name of the server communication link.

parameters
ServerCommunicationLink

The required parameters for creating a server communication link.

Returns

Deletes a server communication link.

function delete(resourceGroupName: string, serverName: string, communicationLinkName: string, options?: ServerCommunicationLinksDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

communicationLinkName

string

The name of the server communication link.

options
ServerCommunicationLinksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

Returns a server communication link.

function get(resourceGroupName: string, serverName: string, communicationLinkName: string, options?: ServerCommunicationLinksGetOptionalParams): Promise<ServerCommunicationLink>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

communicationLinkName

string

The name of the server communication link.

options
ServerCommunicationLinksGetOptionalParams

The options parameters.

Returns

Gets a list of server communication links.

function listByServer(resourceGroupName: string, serverName: string, options?: ServerCommunicationLinksListByServerOptionalParams): PagedAsyncIterableIterator<ServerCommunicationLink, ServerCommunicationLink[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options
ServerCommunicationLinksListByServerOptionalParams

The options parameters.

Returns