ResourceSyncRules interface

Package:

@azure/arm-extendedlocation

Interface representing a ResourceSyncRules.

Methods

beginCreateOrUpdate(string, string, string, ResourceSyncRule, ResourceSyncRulesCreateOrUpdateOptionalParams)	Creates or updates a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group
beginCreateOrUpdateAndWait(string, string, string, ResourceSyncRule, ResourceSyncRulesCreateOrUpdateOptionalParams)	Creates or updates a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group
beginUpdate(string, string, string, ResourceSyncRulesUpdateOptionalParams)	Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name.
beginUpdateAndWait(string, string, string, ResourceSyncRulesUpdateOptionalParams)	Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name.
delete(string, string, string, ResourceSyncRulesDeleteOptionalParams)	Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id.
get(string, string, string, ResourceSyncRulesGetOptionalParams)	Gets the details of the resourceSyncRule with a specified resource group, subscription id Custom Location resource name and Resource Sync Rule name.
listByCustomLocationID(string, string, ResourceSyncRulesListByCustomLocationIDOptionalParams)	Gets a list of Resource Sync Rules in the specified subscription. The operation returns properties of each Resource Sync Rule

Method Details

beginCreateOrUpdate(string, string, string, ResourceSyncRule, ResourceSyncRulesCreateOrUpdateOptionalParams)

Creates or updates a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, childResourceName: string, parameters: ResourceSyncRule, options?: ResourceSyncRulesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ResourceSyncRule>, ResourceSyncRule>>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

childResourceName

string

Resource Sync Rule name.

parameters

ResourceSyncRule

Parameters supplied to create or update a Resource Sync Rule.

options

ResourceSyncRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, ResourceSyncRule, ResourceSyncRulesCreateOrUpdateOptionalParams)

Creates or updates a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, childResourceName: string, parameters: ResourceSyncRule, options?: ResourceSyncRulesCreateOrUpdateOptionalParams): Promise<ResourceSyncRule>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

childResourceName

string

Resource Sync Rule name.

parameters

ResourceSyncRule

Parameters supplied to create or update a Resource Sync Rule.

options

ResourceSyncRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ResourceSyncRule>

beginUpdate(string, string, string, ResourceSyncRulesUpdateOptionalParams)

Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name.

function beginUpdate(resourceGroupName: string, resourceName: string, childResourceName: string, options?: ResourceSyncRulesUpdateOptionalParams): Promise<PollerLike<PollOperationState<ResourceSyncRule>, ResourceSyncRule>>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

childResourceName

string

Resource Sync Rule name.

options

ResourceSyncRulesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, ResourceSyncRulesUpdateOptionalParams)

Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name.

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, childResourceName: string, options?: ResourceSyncRulesUpdateOptionalParams): Promise<ResourceSyncRule>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

childResourceName

string

Resource Sync Rule name.

options

ResourceSyncRulesUpdateOptionalParams

The options parameters.

Returns

Promise<ResourceSyncRule>

delete(string, string, string, ResourceSyncRulesDeleteOptionalParams)

Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id.

function delete(resourceGroupName: string, resourceName: string, childResourceName: string, options?: ResourceSyncRulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

childResourceName

string

Resource Sync Rule name.

options

ResourceSyncRulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ResourceSyncRulesGetOptionalParams)

Gets the details of the resourceSyncRule with a specified resource group, subscription id Custom Location resource name and Resource Sync Rule name.

function get(resourceGroupName: string, resourceName: string, childResourceName: string, options?: ResourceSyncRulesGetOptionalParams): Promise<ResourceSyncRule>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

childResourceName

string

Resource Sync Rule name.

options

ResourceSyncRulesGetOptionalParams

The options parameters.

Returns

Promise<ResourceSyncRule>

listByCustomLocationID(string, string, ResourceSyncRulesListByCustomLocationIDOptionalParams)

Gets a list of Resource Sync Rules in the specified subscription. The operation returns properties of each Resource Sync Rule

function listByCustomLocationID(resourceGroupName: string, resourceName: string, options?: ResourceSyncRulesListByCustomLocationIDOptionalParams): PagedAsyncIterableIterator<ResourceSyncRule, ResourceSyncRule[], PageSettings>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

options

ResourceSyncRulesListByCustomLocationIDOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ResourceSyncRule, ResourceSyncRule[], PageSettings>