StorageSyncServices interface

Package:

@azure/arm-storagesync

Interface representing a StorageSyncServices.

Methods

beginCreate(string, string, StorageSyncServiceCreateParameters, StorageSyncServicesCreateOptionalParams)	Create a new StorageSyncService.
beginCreateAndWait(string, string, StorageSyncServiceCreateParameters, StorageSyncServicesCreateOptionalParams)	Create a new StorageSyncService.
beginDelete(string, string, StorageSyncServicesDeleteOptionalParams)	Delete a given StorageSyncService.
beginDeleteAndWait(string, string, StorageSyncServicesDeleteOptionalParams)	Delete a given StorageSyncService.
beginUpdate(string, string, StorageSyncServicesUpdateOptionalParams)	Patch a given StorageSyncService.
beginUpdateAndWait(string, string, StorageSyncServicesUpdateOptionalParams)	Patch a given StorageSyncService.
checkNameAvailability(string, CheckNameAvailabilityParameters, StorageSyncServicesCheckNameAvailabilityOptionalParams)	Check the give namespace name availability.
get(string, string, StorageSyncServicesGetOptionalParams)	Get a given StorageSyncService.
listByResourceGroup(string, StorageSyncServicesListByResourceGroupOptionalParams)	Get a StorageSyncService list by Resource group name.
listBySubscription(StorageSyncServicesListBySubscriptionOptionalParams)	Get a StorageSyncService list by subscription.

Method Details

beginCreate(string, string, StorageSyncServiceCreateParameters, StorageSyncServicesCreateOptionalParams)

Create a new StorageSyncService.

function beginCreate(resourceGroupName: string, storageSyncServiceName: string, parameters: StorageSyncServiceCreateParameters, options?: StorageSyncServicesCreateOptionalParams): Promise<PollerLike<PollOperationState<StorageSyncService>, StorageSyncService>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

parameters

StorageSyncServiceCreateParameters

Storage Sync Service resource name.

options

StorageSyncServicesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, StorageSyncServiceCreateParameters, StorageSyncServicesCreateOptionalParams)

Create a new StorageSyncService.

function beginCreateAndWait(resourceGroupName: string, storageSyncServiceName: string, parameters: StorageSyncServiceCreateParameters, options?: StorageSyncServicesCreateOptionalParams): Promise<StorageSyncService>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

parameters

StorageSyncServiceCreateParameters

Storage Sync Service resource name.

options

StorageSyncServicesCreateOptionalParams

The options parameters.

Returns

Promise<StorageSyncService>

beginDelete(string, string, StorageSyncServicesDeleteOptionalParams)

Delete a given StorageSyncService.

function beginDelete(resourceGroupName: string, storageSyncServiceName: string, options?: StorageSyncServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<StorageSyncServicesDeleteHeaders>, StorageSyncServicesDeleteHeaders>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

StorageSyncServicesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, StorageSyncServicesDeleteOptionalParams)

Delete a given StorageSyncService.

function beginDeleteAndWait(resourceGroupName: string, storageSyncServiceName: string, options?: StorageSyncServicesDeleteOptionalParams): Promise<StorageSyncServicesDeleteHeaders>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

StorageSyncServicesDeleteOptionalParams

The options parameters.

Returns

Promise<StorageSyncServicesDeleteHeaders>

beginUpdate(string, string, StorageSyncServicesUpdateOptionalParams)

Patch a given StorageSyncService.

function beginUpdate(resourceGroupName: string, storageSyncServiceName: string, options?: StorageSyncServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<StorageSyncServicesUpdateResponse>, StorageSyncServicesUpdateResponse>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

StorageSyncServicesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, StorageSyncServicesUpdateOptionalParams)

Patch a given StorageSyncService.

function beginUpdateAndWait(resourceGroupName: string, storageSyncServiceName: string, options?: StorageSyncServicesUpdateOptionalParams): Promise<StorageSyncServicesUpdateResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

StorageSyncServicesUpdateOptionalParams

The options parameters.

Returns

Promise<StorageSyncServicesUpdateResponse>

checkNameAvailability(string, CheckNameAvailabilityParameters, StorageSyncServicesCheckNameAvailabilityOptionalParams)

Check the give namespace name availability.

function checkNameAvailability(locationName: string, parameters: CheckNameAvailabilityParameters, options?: StorageSyncServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

locationName

string

The desired region for the name check.

parameters

CheckNameAvailabilityParameters

Parameters to check availability of the given namespace name

options

StorageSyncServicesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResult>

get(string, string, StorageSyncServicesGetOptionalParams)

Get a given StorageSyncService.

function get(resourceGroupName: string, storageSyncServiceName: string, options?: StorageSyncServicesGetOptionalParams): Promise<StorageSyncServicesGetResponse>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

StorageSyncServicesGetOptionalParams

The options parameters.

Returns

Promise<StorageSyncServicesGetResponse>

listByResourceGroup(string, StorageSyncServicesListByResourceGroupOptionalParams)

Get a StorageSyncService list by Resource group name.

function listByResourceGroup(resourceGroupName: string, options?: StorageSyncServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StorageSyncService, StorageSyncService[], PageSettings>

Parameters

resourceGroupName

string

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

options

StorageSyncServicesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StorageSyncService, StorageSyncService[], PageSettings>

listBySubscription(StorageSyncServicesListBySubscriptionOptionalParams)

Get a StorageSyncService list by subscription.

function listBySubscription(options?: StorageSyncServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<StorageSyncService, StorageSyncService[], PageSettings>

Parameters

options

StorageSyncServicesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<StorageSyncService, StorageSyncService[], PageSettings>