EnergyServices interface

Package:

@azure/arm-oep

Interface representing a EnergyServices.

Methods

beginCreate(string, string, EnergyServicesCreateOptionalParams)	Method that gets called if subscribed for ResourceCreationBegin trigger.
beginCreateAndWait(string, string, EnergyServicesCreateOptionalParams)	Method that gets called if subscribed for ResourceCreationBegin trigger.
beginDelete(string, string, EnergyServicesDeleteOptionalParams)	Deletes oep resource
beginDeleteAndWait(string, string, EnergyServicesDeleteOptionalParams)	Deletes oep resource
get(string, string, EnergyServicesGetOptionalParams)	Returns oep resource for a given name.
listByResourceGroup(string, EnergyServicesListByResourceGroupOptionalParams)	Returns list of oep resources..
listBySubscription(EnergyServicesListBySubscriptionOptionalParams)	Lists a collection of oep resources under the given Azure Subscription ID.
update(string, string, EnergyServicesUpdateOptionalParams)

Method Details

beginCreate(string, string, EnergyServicesCreateOptionalParams)

Method that gets called if subscribed for ResourceCreationBegin trigger.

function beginCreate(resourceGroupName: string, resourceName: string, options?: EnergyServicesCreateOptionalParams): Promise<PollerLike<PollOperationState<EnergyService>, EnergyService>>

Parameters

resourceGroupName

string

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

resourceName

string

The resource name.

options

EnergyServicesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, EnergyServicesCreateOptionalParams)

Method that gets called if subscribed for ResourceCreationBegin trigger.

function beginCreateAndWait(resourceGroupName: string, resourceName: string, options?: EnergyServicesCreateOptionalParams): Promise<EnergyService>

Parameters

resourceGroupName

string

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

resourceName

string

The resource name.

options

EnergyServicesCreateOptionalParams

The options parameters.

Returns

Promise<EnergyService>

beginDelete(string, string, EnergyServicesDeleteOptionalParams)

Deletes oep resource

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

Parameters

resourceGroupName

string

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

resourceName

string

The resource name.

options

EnergyServicesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, EnergyServicesDeleteOptionalParams)

Deletes oep resource

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

Parameters

resourceGroupName

string

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

resourceName

string

The resource name.

options

EnergyServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, EnergyServicesGetOptionalParams)

Returns oep resource for a given name.

function get(resourceGroupName: string, resourceName: string, options?: EnergyServicesGetOptionalParams): Promise<EnergyService>

Parameters

resourceGroupName

string

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

resourceName

string

The resource name.

options

EnergyServicesGetOptionalParams

The options parameters.

Returns

Promise<EnergyService>

listByResourceGroup(string, EnergyServicesListByResourceGroupOptionalParams)

Returns list of oep resources..

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

Parameters

resourceGroupName

string

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

options

EnergyServicesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EnergyService, EnergyService[], PageSettings>

listBySubscription(EnergyServicesListBySubscriptionOptionalParams)

Lists a collection of oep resources under the given Azure Subscription ID.

function listBySubscription(options?: EnergyServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<EnergyService, EnergyService[], PageSettings>

Parameters

options

EnergyServicesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EnergyService, EnergyService[], PageSettings>

update(string, string, EnergyServicesUpdateOptionalParams)

function update(resourceGroupName: string, resourceName: string, options?: EnergyServicesUpdateOptionalParams): Promise<EnergyService>

Parameters

resourceGroupName

string

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

resourceName

string

The resource name.

options

EnergyServicesUpdateOptionalParams

The options parameters.

Returns

Promise<EnergyService>