RegisteredServers interface

Package:

@azure/arm-storagesync

Interface representing a RegisteredServers.

Methods

beginCreate(string, string, string, RegisteredServerCreateParameters, RegisteredServersCreateOptionalParams)	Add a new registered server.
beginCreateAndWait(string, string, string, RegisteredServerCreateParameters, RegisteredServersCreateOptionalParams)	Add a new registered server.
beginDelete(string, string, string, RegisteredServersDeleteOptionalParams)	Delete the given registered server.
beginDeleteAndWait(string, string, string, RegisteredServersDeleteOptionalParams)	Delete the given registered server.
beginTriggerRollover(string, string, string, TriggerRolloverRequest, RegisteredServersTriggerRolloverOptionalParams)	Triggers Server certificate rollover.
beginTriggerRolloverAndWait(string, string, string, TriggerRolloverRequest, RegisteredServersTriggerRolloverOptionalParams)	Triggers Server certificate rollover.
get(string, string, string, RegisteredServersGetOptionalParams)	Get a given registered server.
listByStorageSyncService(string, string, RegisteredServersListByStorageSyncServiceOptionalParams)	Get a given registered server list.

Method Details

beginCreate(string, string, string, RegisteredServerCreateParameters, RegisteredServersCreateOptionalParams)

Add a new registered server.

function beginCreate(resourceGroupName: string, storageSyncServiceName: string, serverId: string, parameters: RegisteredServerCreateParameters, options?: RegisteredServersCreateOptionalParams): Promise<PollerLike<PollOperationState<RegisteredServersCreateResponse>, RegisteredServersCreateResponse>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

serverId

string

GUID identifying the on-premises server.

parameters

RegisteredServerCreateParameters

Body of Registered Server object.

options

RegisteredServersCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, RegisteredServerCreateParameters, RegisteredServersCreateOptionalParams)

Add a new registered server.

function beginCreateAndWait(resourceGroupName: string, storageSyncServiceName: string, serverId: string, parameters: RegisteredServerCreateParameters, options?: RegisteredServersCreateOptionalParams): Promise<RegisteredServersCreateResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

serverId

string

GUID identifying the on-premises server.

parameters

RegisteredServerCreateParameters

Body of Registered Server object.

options

RegisteredServersCreateOptionalParams

The options parameters.

Returns

Promise<RegisteredServersCreateResponse>

beginDelete(string, string, string, RegisteredServersDeleteOptionalParams)

Delete the given registered server.

function beginDelete(resourceGroupName: string, storageSyncServiceName: string, serverId: string, options?: RegisteredServersDeleteOptionalParams): Promise<PollerLike<PollOperationState<RegisteredServersDeleteHeaders>, RegisteredServersDeleteHeaders>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

serverId

string

GUID identifying the on-premises server.

options

RegisteredServersDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, RegisteredServersDeleteOptionalParams)

Delete the given registered server.

function beginDeleteAndWait(resourceGroupName: string, storageSyncServiceName: string, serverId: string, options?: RegisteredServersDeleteOptionalParams): Promise<RegisteredServersDeleteHeaders>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

serverId

string

GUID identifying the on-premises server.

options

RegisteredServersDeleteOptionalParams

The options parameters.

Returns

Promise<RegisteredServersDeleteHeaders>

beginTriggerRollover(string, string, string, TriggerRolloverRequest, RegisteredServersTriggerRolloverOptionalParams)

Triggers Server certificate rollover.

function beginTriggerRollover(resourceGroupName: string, storageSyncServiceName: string, serverId: string, parameters: TriggerRolloverRequest, options?: RegisteredServersTriggerRolloverOptionalParams): Promise<PollerLike<PollOperationState<RegisteredServersTriggerRolloverHeaders>, RegisteredServersTriggerRolloverHeaders>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

serverId

string

Server Id

parameters

TriggerRolloverRequest

Body of Trigger Rollover request.

options

RegisteredServersTriggerRolloverOptionalParams

The options parameters.

Returns

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

beginTriggerRolloverAndWait(string, string, string, TriggerRolloverRequest, RegisteredServersTriggerRolloverOptionalParams)

Triggers Server certificate rollover.

function beginTriggerRolloverAndWait(resourceGroupName: string, storageSyncServiceName: string, serverId: string, parameters: TriggerRolloverRequest, options?: RegisteredServersTriggerRolloverOptionalParams): Promise<RegisteredServersTriggerRolloverHeaders>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

serverId

string

Server Id

parameters

TriggerRolloverRequest

Body of Trigger Rollover request.

options

RegisteredServersTriggerRolloverOptionalParams

The options parameters.

Returns

Promise<RegisteredServersTriggerRolloverHeaders>

get(string, string, string, RegisteredServersGetOptionalParams)

Get a given registered server.

function get(resourceGroupName: string, storageSyncServiceName: string, serverId: string, options?: RegisteredServersGetOptionalParams): Promise<RegisteredServersGetResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

serverId

string

GUID identifying the on-premises server.

options

RegisteredServersGetOptionalParams

The options parameters.

Returns

Promise<RegisteredServersGetResponse>

listByStorageSyncService(string, string, RegisteredServersListByStorageSyncServiceOptionalParams)

Get a given registered server list.

function listByStorageSyncService(resourceGroupName: string, storageSyncServiceName: string, options?: RegisteredServersListByStorageSyncServiceOptionalParams): PagedAsyncIterableIterator<RegisteredServer, RegisteredServer[], PageSettings>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

RegisteredServersListByStorageSyncServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RegisteredServer, RegisteredServer[], PageSettings>