server_communication_links

Creates, updates, deletes, gets or lists a server_communication_links resource.

Overview

Name	server_communication_links
Type	Resource
Id	azure.sql.server_communication_links

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
kind	string	Communication link kind. This property is used for Azure Portal metadata.
location	string	Communication link location.
properties	object	The properties of resource.

list_by_server

Name	Datatype	Description
kind	string	Communication link kind. This property is used for Azure Portal metadata.
location	string	Communication link location.
properties	object	The properties of resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, communicationLinkName		Returns a server communication link.
list_by_server	select	subscriptionId, resourceGroupName, serverName		Gets a list of server communication links.
create_or_update	insert	subscriptionId, resourceGroupName, serverName, communicationLinkName		Creates a server communication link.
delete	delete	subscriptionId, resourceGroupName, serverName, communicationLinkName		Deletes a server communication link.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
communicationLinkName	string	The name of the server communication link.
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.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Returns a server communication link.

SELECT
kind,
location,
properties
FROM azure.sql.server_communication_links
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND communicationLinkName = '{{ communicationLinkName }}' -- required
;

list_by_server

Gets a list of server communication links.

SELECT
kind,
location,
properties
FROM azure.sql.server_communication_links
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

INSERT examples

create_or_update

Creates a server communication link.

INSERT INTO azure.sql.server_communication_links (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
communicationLinkName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ communicationLinkName }}'
RETURNING
kind,
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_communication_links
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the server_communication_links resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_communication_links resource.
    - name: serverName
      value: string
      description: Required parameter for the server_communication_links resource.
    - name: communicationLinkName
      value: string
      description: Required parameter for the server_communication_links resource.
    - name: properties
      value: object
      description: |
        The properties of resource.

DELETE examples

delete

Deletes a server communication link.

DELETE FROM azure.sql.server_communication_links
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND communicationLinkName = '{{ communicationLinkName }}' --required
;