CustomLocations interface

Package:

@azure/arm-extendedlocation

Interface representing a CustomLocations.

Methods

beginCreateOrUpdate(string, string, CustomLocation, CustomLocationsCreateOrUpdateOptionalParams)	Creates or updates a Custom Location in the specified Subscription and Resource Group
beginCreateOrUpdateAndWait(string, string, CustomLocation, CustomLocationsCreateOrUpdateOptionalParams)	Creates or updates a Custom Location in the specified Subscription and Resource Group
beginDelete(string, string, CustomLocationsDeleteOptionalParams)	Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.
beginDeleteAndWait(string, string, CustomLocationsDeleteOptionalParams)	Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.
findTargetResourceGroup(string, string, CustomLocationFindTargetResourceGroupProperties, CustomLocationsFindTargetResourceGroupOptionalParams)	Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request.
get(string, string, CustomLocationsGetOptionalParams)	Gets the details of the customLocation with a specified resource group and name.
listByResourceGroup(string, CustomLocationsListByResourceGroupOptionalParams)	Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.
listBySubscription(CustomLocationsListBySubscriptionOptionalParams)	Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location
listEnabledResourceTypes(string, string, CustomLocationsListEnabledResourceTypesOptionalParams)	Gets the list of the Enabled Resource Types.
listOperations(CustomLocationsListOperationsOptionalParams)	Lists all available Custom Locations operations.
update(string, string, CustomLocationsUpdateOptionalParams)	Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.

Method Details

beginCreateOrUpdate(string, string, CustomLocation, CustomLocationsCreateOrUpdateOptionalParams)

Creates or updates a Custom Location in the specified Subscription and Resource Group

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: CustomLocation, options?: CustomLocationsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CustomLocation>, CustomLocation>>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

parameters

CustomLocation

Parameters supplied to create or update a Custom Location.

options

CustomLocationsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, CustomLocation, CustomLocationsCreateOrUpdateOptionalParams)

Creates or updates a Custom Location in the specified Subscription and Resource Group

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: CustomLocation, options?: CustomLocationsCreateOrUpdateOptionalParams): Promise<CustomLocation>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

parameters

CustomLocation

Parameters supplied to create or update a Custom Location.

options

CustomLocationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CustomLocation>

beginDelete(string, string, CustomLocationsDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, resourceName: string, options?: CustomLocationsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

options

CustomLocationsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, CustomLocationsDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: CustomLocationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

options

CustomLocationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

findTargetResourceGroup(string, string, CustomLocationFindTargetResourceGroupProperties, CustomLocationsFindTargetResourceGroupOptionalParams)

Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request.

function findTargetResourceGroup(resourceGroupName: string, resourceName: string, parameters: CustomLocationFindTargetResourceGroupProperties, options?: CustomLocationsFindTargetResourceGroupOptionalParams): Promise<CustomLocationFindTargetResourceGroupResult>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

parameters

CustomLocationFindTargetResourceGroupProperties

Parameters of the find target resource group request.

options

CustomLocationsFindTargetResourceGroupOptionalParams

The options parameters.

Returns

Promise<CustomLocationFindTargetResourceGroupResult>

get(string, string, CustomLocationsGetOptionalParams)

Gets the details of the customLocation with a specified resource group and name.

function get(resourceGroupName: string, resourceName: string, options?: CustomLocationsGetOptionalParams): Promise<CustomLocation>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

options

CustomLocationsGetOptionalParams

The options parameters.

Returns

Promise<CustomLocation>

listByResourceGroup(string, CustomLocationsListByResourceGroupOptionalParams)

Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.

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

Parameters

resourceGroupName

string

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

options

CustomLocationsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomLocation, CustomLocation[], PageSettings>

listBySubscription(CustomLocationsListBySubscriptionOptionalParams)

Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location

function listBySubscription(options?: CustomLocationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CustomLocation, CustomLocation[], PageSettings>

Parameters

options

CustomLocationsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomLocation, CustomLocation[], PageSettings>

listEnabledResourceTypes(string, string, CustomLocationsListEnabledResourceTypesOptionalParams)

Gets the list of the Enabled Resource Types.

function listEnabledResourceTypes(resourceGroupName: string, resourceName: string, options?: CustomLocationsListEnabledResourceTypesOptionalParams): PagedAsyncIterableIterator<EnabledResourceType, EnabledResourceType[], PageSettings>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

options

CustomLocationsListEnabledResourceTypesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EnabledResourceType, EnabledResourceType[], PageSettings>

listOperations(CustomLocationsListOperationsOptionalParams)

Lists all available Custom Locations operations.

function listOperations(options?: CustomLocationsListOperationsOptionalParams): PagedAsyncIterableIterator<CustomLocationOperation, CustomLocationOperation[], PageSettings>

Parameters

options

CustomLocationsListOperationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CustomLocationOperation, CustomLocationOperation[], PageSettings>

update(string, string, CustomLocationsUpdateOptionalParams)

Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.

function update(resourceGroupName: string, resourceName: string, options?: CustomLocationsUpdateOptionalParams): Promise<CustomLocation>

Parameters

resourceGroupName

string

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

resourceName

string

Custom Locations name.

options

CustomLocationsUpdateOptionalParams

The options parameters.

Returns

Promise<CustomLocation>