CustomLocationsOperations interface

Package:
@azure/arm-extendedlocation

Interface representing a CustomLocations operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate

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

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

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

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

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

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

Gets the list of the Enabled Resource Types.
listOperations

Lists all available Custom Locations operations.
update

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

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, resourceName: string, parameters: CustomLocation, options?: CustomLocationsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<CustomLocation>, CustomLocation>>

Property Value

(resourceGroupName: string, resourceName: string, parameters: CustomLocation, options?: CustomLocationsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<CustomLocation>, CustomLocation>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, resourceName: string, options?: CustomLocationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, resourceName: string, options?: CustomLocationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, resourceName: string, parameters: CustomLocation, options?: CustomLocationsCreateOrUpdateOptionalParams) => PollerLike<OperationState<CustomLocation>, CustomLocation>

Property Value

(resourceGroupName: string, resourceName: string, parameters: CustomLocation, options?: CustomLocationsCreateOrUpdateOptionalParams) => PollerLike<OperationState<CustomLocation>, CustomLocation>

delete

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

delete: (resourceGroupName: string, resourceName: string, options?: CustomLocationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, resourceName: string, options?: CustomLocationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

findTargetResourceGroup

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.

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

Property Value

(resourceGroupName: string, resourceName: string, parameters: CustomLocationFindTargetResourceGroupProperties, options?: CustomLocationsFindTargetResourceGroupOptionalParams) => Promise<undefined | CustomLocationFindTargetResourceGroupResult>

get

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

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

Property Value

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

listByResourceGroup

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

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

Property Value

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

listBySubscription

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

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

Property Value

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

listEnabledResourceTypes

Gets the list of the Enabled Resource Types.

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

Property Value

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

listOperations

Lists all available Custom Locations operations.

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

Property Value

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

update

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

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

Property Value

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