ServerEndpoints interface

Package:

@azure/arm-storagesync

Interface representing a ServerEndpoints.

Methods

beginCreate(string, string, string, string, ServerEndpointCreateParameters, ServerEndpointsCreateOptionalParams)	Create a new ServerEndpoint.
beginCreateAndWait(string, string, string, string, ServerEndpointCreateParameters, ServerEndpointsCreateOptionalParams)	Create a new ServerEndpoint.
beginDelete(string, string, string, string, ServerEndpointsDeleteOptionalParams)	Delete a given ServerEndpoint.
beginDeleteAndWait(string, string, string, string, ServerEndpointsDeleteOptionalParams)	Delete a given ServerEndpoint.
beginRecallAction(string, string, string, string, RecallActionParameters, ServerEndpointsRecallActionOptionalParams)	Recall a server endpoint.
beginRecallActionAndWait(string, string, string, string, RecallActionParameters, ServerEndpointsRecallActionOptionalParams)	Recall a server endpoint.
beginUpdate(string, string, string, string, ServerEndpointsUpdateOptionalParams)	Patch a given ServerEndpoint.
beginUpdateAndWait(string, string, string, string, ServerEndpointsUpdateOptionalParams)	Patch a given ServerEndpoint.
get(string, string, string, string, ServerEndpointsGetOptionalParams)	Get a ServerEndpoint.
listBySyncGroup(string, string, string, ServerEndpointsListBySyncGroupOptionalParams)	Get a ServerEndpoint list.

Method Details

beginCreate(string, string, string, string, ServerEndpointCreateParameters, ServerEndpointsCreateOptionalParams)

Create a new ServerEndpoint.

function beginCreate(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, parameters: ServerEndpointCreateParameters, options?: ServerEndpointsCreateOptionalParams): Promise<PollerLike<PollOperationState<ServerEndpointsCreateResponse>, ServerEndpointsCreateResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

parameters

ServerEndpointCreateParameters

Body of Server Endpoint object.

options

ServerEndpointsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ServerEndpointsCreateResponse>, ServerEndpointsCreateResponse>>

beginCreateAndWait(string, string, string, string, ServerEndpointCreateParameters, ServerEndpointsCreateOptionalParams)

Create a new ServerEndpoint.

function beginCreateAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, parameters: ServerEndpointCreateParameters, options?: ServerEndpointsCreateOptionalParams): Promise<ServerEndpointsCreateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

parameters

ServerEndpointCreateParameters

Body of Server Endpoint object.

options

ServerEndpointsCreateOptionalParams

The options parameters.

Returns

Promise<ServerEndpointsCreateResponse>

beginDelete(string, string, string, string, ServerEndpointsDeleteOptionalParams)

Delete a given ServerEndpoint.

function beginDelete(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, options?: ServerEndpointsDeleteOptionalParams): Promise<PollerLike<PollOperationState<ServerEndpointsDeleteHeaders>, ServerEndpointsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

options

ServerEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ServerEndpointsDeleteHeaders>, ServerEndpointsDeleteHeaders>>

beginDeleteAndWait(string, string, string, string, ServerEndpointsDeleteOptionalParams)

Delete a given ServerEndpoint.

function beginDeleteAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, options?: ServerEndpointsDeleteOptionalParams): Promise<ServerEndpointsDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

options

ServerEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<ServerEndpointsDeleteHeaders>

beginRecallAction(string, string, string, string, RecallActionParameters, ServerEndpointsRecallActionOptionalParams)

Recall a server endpoint.

function beginRecallAction(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, parameters: RecallActionParameters, options?: ServerEndpointsRecallActionOptionalParams): Promise<PollerLike<PollOperationState<ServerEndpointsRecallActionHeaders>, ServerEndpointsRecallActionHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

parameters

RecallActionParameters

Body of Recall Action object.

options

ServerEndpointsRecallActionOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ServerEndpointsRecallActionHeaders>, ServerEndpointsRecallActionHeaders>>

beginRecallActionAndWait(string, string, string, string, RecallActionParameters, ServerEndpointsRecallActionOptionalParams)

Recall a server endpoint.

function beginRecallActionAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, parameters: RecallActionParameters, options?: ServerEndpointsRecallActionOptionalParams): Promise<ServerEndpointsRecallActionHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

parameters

RecallActionParameters

Body of Recall Action object.

options

ServerEndpointsRecallActionOptionalParams

The options parameters.

Returns

Promise<ServerEndpointsRecallActionHeaders>

beginUpdate(string, string, string, string, ServerEndpointsUpdateOptionalParams)

Patch a given ServerEndpoint.

function beginUpdate(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, options?: ServerEndpointsUpdateOptionalParams): Promise<PollerLike<PollOperationState<ServerEndpointsUpdateResponse>, ServerEndpointsUpdateResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

options

ServerEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ServerEndpointsUpdateResponse>, ServerEndpointsUpdateResponse>>

beginUpdateAndWait(string, string, string, string, ServerEndpointsUpdateOptionalParams)

Patch a given ServerEndpoint.

function beginUpdateAndWait(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, options?: ServerEndpointsUpdateOptionalParams): Promise<ServerEndpointsUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

options

ServerEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<ServerEndpointsUpdateResponse>

get(string, string, string, string, ServerEndpointsGetOptionalParams)

Get a ServerEndpoint.

function get(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, serverEndpointName: string, options?: ServerEndpointsGetOptionalParams): Promise<ServerEndpointsGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

serverEndpointName

string

Name of Server Endpoint object.

options

ServerEndpointsGetOptionalParams

The options parameters.

Returns

Promise<ServerEndpointsGetResponse>

listBySyncGroup(string, string, string, ServerEndpointsListBySyncGroupOptionalParams)

Get a ServerEndpoint list.

function listBySyncGroup(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, options?: ServerEndpointsListBySyncGroupOptionalParams): PagedAsyncIterableIterator<ServerEndpoint, ServerEndpoint[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageSyncServiceName

string

Name of Storage Sync Service resource.

syncGroupName

string

Name of Sync Group resource.

options

ServerEndpointsListBySyncGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ServerEndpoint, ServerEndpoint[], PageSettings>