linked_servers

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

Overview

Name	linked_servers
Type	Resource
Id	azure_isv.redis.linked_servers

Fields

The following fields are returned by SELECT queries:

get

Response of get linked server.

Name	Datatype	Description
properties	object	Properties of the linked server.

list

Response of get linked servers.

Name	Datatype	Description
properties	object	Properties of the linked server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, linkedServerName, subscriptionId		Gets the detailed information about a linked server of a redis cache (requires Premium SKU).
list	select	resourceGroupName, name, subscriptionId		Gets the list of linked servers associated with this redis cache (requires Premium SKU).
create	insert	resourceGroupName, name, linkedServerName, subscriptionId, data__properties		Adds a linked server to the Redis cache (requires Premium SKU).
delete	delete	resourceGroupName, name, linkedServerName, subscriptionId		Deletes the linked server from a redis cache (requires Premium SKU).

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
linkedServerName	string	The name of the linked server that is being added to the Redis cache.
name	string	The name of the redis cache.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

SELECT
properties
FROM azure_isv.redis.linked_servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND linkedServerName = '{{ linkedServerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets the list of linked servers associated with this redis cache (requires Premium SKU).

SELECT
properties
FROM azure_isv.redis.linked_servers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Adds a linked server to the Redis cache (requires Premium SKU).

INSERT INTO azure_isv.redis.linked_servers (
data__properties,
resourceGroupName,
name,
linkedServerName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ name }}',
'{{ linkedServerName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: linked_servers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the linked_servers resource.
    - name: name
      value: string
      description: Required parameter for the linked_servers resource.
    - name: linkedServerName
      value: string
      description: Required parameter for the linked_servers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the linked_servers resource.
    - name: properties
      value: object
      description: |
        Properties required to create a linked server.

DELETE examples

delete

Deletes the linked server from a redis cache (requires Premium SKU).

DELETE FROM azure_isv.redis.linked_servers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND linkedServerName = '{{ linkedServerName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;