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

vw_server_communication_links

Name	Datatype	Description
communicationLinkName	text	field from the properties object
kind	text	Communication link kind. This property is used for Azure Portal metadata.
location	text	Communication link location.
partner_server	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object

server_communication_links

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 a server communication link.

Methods

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

SELECT examples

Gets a list of server communication links.

vw_server_communication_links

SELECT
communicationLinkName,
kind,
location,
partner_server,
resourceGroupName,
serverName,
state,
subscriptionId
FROM azure.sql.vw_server_communication_links
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

server_communication_links

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

INSERT example

Use the following StackQL query and manifest file to create a new server_communication_links resource.

All Properties

/*+ create */
INSERT INTO azure.sql.server_communication_links (
communicationLinkName,
resourceGroupName,
serverName,
subscriptionId,
properties
)
SELECT 
'{{ communicationLinkName }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: state
          value: string
        - name: partnerServer
          value: string
    - name: location
      value: string
    - name: kind
      value: string

DELETE example

Deletes the specified server_communication_links resource.

/*+ delete */
DELETE FROM azure.sql.server_communication_links
WHERE communicationLinkName = '{{ communicationLinkName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';