CustomLocationsImpl | @azure/arm-extendedlocation

Class containing CustomLocations operations.

Hierarchy

CustomLocationsImpl

Implements

CustomLocations

Index

Constructors

constructor

Methods

Constructors

constructor

new CustomLocationsImpl(client: CustomLocationsManagementClientContext): CustomLocationsImpl

- Defined in operations/customLocations.ts:49
Initialize a new instance of the class CustomLocations class.

Parameters
- client: CustomLocationsManagementClientContext
  
  Reference to the service client
Returns CustomLocationsImpl

Methods

beginCreateOrUpdate

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

Implementation of CustomLocations.beginCreateOrUpdate
- Defined in operations/customLocations.ts:336
Creates or updates a Custom Location in the specified Subscription and Resource Group

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.
- Optional options: CustomLocationsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CustomLocationsCreateOrUpdateResponse>, CustomLocationsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

Implementation of CustomLocations.beginCreateOrUpdateAndWait
- Defined in operations/customLocations.ts:405
Creates or updates a Custom Location in the specified Subscription and Resource Group

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.
- Optional options: CustomLocationsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CustomLocationsCreateOrUpdateResponse>

beginDelete

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

Implementation of CustomLocations.beginDelete
- Defined in operations/customLocations.ts:426
Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Custom Locations name.
- Optional options: CustomLocationsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of CustomLocations.beginDeleteAndWait
- Defined in operations/customLocations.ts:488
Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Custom Locations name.
- Optional options: CustomLocationsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of CustomLocations.get
- Defined in operations/customLocations.ts:318
Gets the details of the customLocation with a specified resource group and name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Custom Locations name.
- Optional options: CustomLocationsGetOptionalParams
  
  The options parameters.
Returns Promise<CustomLocationsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: CustomLocationsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<CustomLocation>

Implementation of CustomLocations.listByResourceGroup
- Defined in operations/customLocations.ts:150
Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: CustomLocationsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CustomLocation>

listBySubscription

listBySubscription(options?: CustomLocationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CustomLocation>

Implementation of CustomLocations.listBySubscription
- Defined in operations/customLocations.ts:106
Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location

Parameters
- Optional options: CustomLocationsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CustomLocation>

listEnabledResourceTypes

listEnabledResourceTypes(resourceGroupName: string, resourceName: string, options?: CustomLocationsListEnabledResourceTypesOptionalParams): PagedAsyncIterableIterator<EnabledResourceType>

Implementation of CustomLocations.listEnabledResourceTypes
- Defined in operations/customLocations.ts:204
Gets the list of the Enabled Resource Types.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Custom Locations name.
- Optional options: CustomLocationsListEnabledResourceTypesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EnabledResourceType>

listOperations

listOperations(options?: CustomLocationsListOperationsOptionalParams): PagedAsyncIterableIterator<CustomLocationOperation>

Implementation of CustomLocations.listOperations
- Defined in operations/customLocations.ts:63
Lists all available Custom Locations operations.

Parameters
- Optional options: CustomLocationsListOperationsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CustomLocationOperation>

update

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

Implementation of CustomLocations.update
- Defined in operations/customLocations.ts:508
Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Custom Locations name.
- Optional options: CustomLocationsUpdateOptionalParams
  
  The options parameters.
Returns Promise<CustomLocationsUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CustomLocationsManagementClientContext

Returns CustomLocationsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: CustomLocation

Optional options: CustomLocationsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CustomLocationsCreateOrUpdateResponse>, CustomLocationsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: CustomLocation

Optional options: CustomLocationsCreateOrUpdateOptionalParams

Returns Promise<CustomLocationsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

Optional options: CustomLocationsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: CustomLocationsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

resourceName: string

Optional options: CustomLocationsGetOptionalParams

Returns Promise<CustomLocationsGetResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: CustomLocationsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<CustomLocation>

listBySubscription

Parameters

Optional options: CustomLocationsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<CustomLocation>

listEnabledResourceTypes

Parameters

resourceGroupName: string

resourceName: string

Optional options: CustomLocationsListEnabledResourceTypesOptionalParams

Returns PagedAsyncIterableIterator<EnabledResourceType>

listOperations

Parameters

Optional options: CustomLocationsListOperationsOptionalParams

Returns PagedAsyncIterableIterator<CustomLocationOperation>

update

Parameters

resourceGroupName: string

resourceName: string

Optional options: CustomLocationsUpdateOptionalParams

Returns Promise<CustomLocationsUpdateResponse>