LinkedServer interface
Interface representing a LinkedServer.
Methods
| begin |
Adds a linked server to the Redis cache (requires Premium SKU). |
| begin |
Adds a linked server to the Redis cache (requires Premium SKU). |
| begin |
Deletes the linked server from a redis cache (requires Premium SKU). |
| begin |
Deletes the linked server from a redis cache (requires Premium SKU). |
| get(string, string, string, Linked |
Gets the detailed information about a linked server of a redis cache (requires Premium SKU). |
| list(string, string, Linked |
Gets the list of linked servers associated with this redis cache (requires Premium SKU). |
Method Details
beginCreate(string, string, string, RedisLinkedServerCreateParameters, LinkedServerCreateOptionalParams)
Adds a linked server to the Redis cache (requires Premium SKU).
function beginCreate(resourceGroupName: string, name: string, linkedServerName: string, parameters: RedisLinkedServerCreateParameters, options?: LinkedServerCreateOptionalParams): Promise<SimplePollerLike<OperationState<RedisLinkedServerWithProperties>, RedisLinkedServerWithProperties>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- linkedServerName
-
string
The name of the linked server that is being added to the Redis cache.
- parameters
- RedisLinkedServerCreateParameters
Parameters supplied to the Create Linked server operation.
- options
- LinkedServerCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisLinkedServerWithProperties>, RedisLinkedServerWithProperties>>
beginCreateAndWait(string, string, string, RedisLinkedServerCreateParameters, LinkedServerCreateOptionalParams)
Adds a linked server to the Redis cache (requires Premium SKU).
function beginCreateAndWait(resourceGroupName: string, name: string, linkedServerName: string, parameters: RedisLinkedServerCreateParameters, options?: LinkedServerCreateOptionalParams): Promise<RedisLinkedServerWithProperties>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the Redis cache.
- linkedServerName
-
string
The name of the linked server that is being added to the Redis cache.
- parameters
- RedisLinkedServerCreateParameters
Parameters supplied to the Create Linked server operation.
- options
- LinkedServerCreateOptionalParams
The options parameters.
Returns
Promise<RedisLinkedServerWithProperties>
beginDelete(string, string, string, LinkedServerDeleteOptionalParams)
Deletes the linked server from a redis cache (requires Premium SKU).
function beginDelete(resourceGroupName: string, name: string, linkedServerName: string, options?: LinkedServerDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the redis cache.
- linkedServerName
-
string
The name of the linked server that is being added to the Redis cache.
- options
- LinkedServerDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, LinkedServerDeleteOptionalParams)
Deletes the linked server from a redis cache (requires Premium SKU).
function beginDeleteAndWait(resourceGroupName: string, name: string, linkedServerName: string, options?: LinkedServerDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the redis cache.
- linkedServerName
-
string
The name of the linked server that is being added to the Redis cache.
- options
- LinkedServerDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, LinkedServerGetOptionalParams)
Gets the detailed information about a linked server of a redis cache (requires Premium SKU).
function get(resourceGroupName: string, name: string, linkedServerName: string, options?: LinkedServerGetOptionalParams): Promise<RedisLinkedServerWithProperties>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the redis cache.
- linkedServerName
-
string
The name of the linked server.
- options
- LinkedServerGetOptionalParams
The options parameters.
Returns
Promise<RedisLinkedServerWithProperties>
list(string, string, LinkedServerListOptionalParams)
Gets the list of linked servers associated with this redis cache (requires Premium SKU).
function list(resourceGroupName: string, name: string, options?: LinkedServerListOptionalParams): PagedAsyncIterableIterator<RedisLinkedServerWithProperties, RedisLinkedServerWithProperties[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- name
-
string
The name of the redis cache.
- options
- LinkedServerListOptionalParams
The options parameters.