SyncGroups interface

Package:

@azure/arm-storagesync

Interface representing a SyncGroups.

Methods

create(string, string, string, SyncGroupCreateParameters, SyncGroupsCreateOptionalParams)	Create a new SyncGroup.
delete(string, string, string, SyncGroupsDeleteOptionalParams)	Delete a given SyncGroup.
get(string, string, string, SyncGroupsGetOptionalParams)	Get a given SyncGroup.
listByStorageSyncService(string, string, SyncGroupsListByStorageSyncServiceOptionalParams)	Get a SyncGroup List.

Method Details

create(string, string, string, SyncGroupCreateParameters, SyncGroupsCreateOptionalParams)

Create a new SyncGroup.

function create(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, parameters: SyncGroupCreateParameters, options?: SyncGroupsCreateOptionalParams): Promise<SyncGroupsCreateResponse>

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.

parameters

SyncGroupCreateParameters

Sync Group Body

options

SyncGroupsCreateOptionalParams

The options parameters.

Returns

Promise<SyncGroupsCreateResponse>

delete(string, string, string, SyncGroupsDeleteOptionalParams)

Delete a given SyncGroup.

function delete(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, options?: SyncGroupsDeleteOptionalParams): Promise<SyncGroupsDeleteHeaders>

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

SyncGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<SyncGroupsDeleteHeaders>

get(string, string, string, SyncGroupsGetOptionalParams)

Get a given SyncGroup.

function get(resourceGroupName: string, storageSyncServiceName: string, syncGroupName: string, options?: SyncGroupsGetOptionalParams): Promise<SyncGroupsGetResponse>

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

SyncGroupsGetOptionalParams

The options parameters.

Returns

Promise<SyncGroupsGetResponse>

listByStorageSyncService(string, string, SyncGroupsListByStorageSyncServiceOptionalParams)

Get a SyncGroup List.

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

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

SyncGroupsListByStorageSyncServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SyncGroup, SyncGroup[], PageSettings>