@azure/arm-oep package

Classes

OpenEnergyPlatformManagementServiceAPIs

Interfaces

CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
DataPartitionNames	The list of Energy services resource's Data Partition Names.
EnergyResourceUpdate	The resource model definition used for updating a tracked ARM resource.
EnergyService	Common fields that are returned in the response for all Azure Resource Manager resources
EnergyServiceList	The list of oep resources.
EnergyServiceProperties
EnergyServices	Interface representing a EnergyServices.
EnergyServicesCreateOptionalParams	Optional parameters.
EnergyServicesDeleteOptionalParams	Optional parameters.
EnergyServicesGetOptionalParams	Optional parameters.
EnergyServicesListByResourceGroupNextOptionalParams	Optional parameters.
EnergyServicesListByResourceGroupOptionalParams	Optional parameters.
EnergyServicesListBySubscriptionNextOptionalParams	Optional parameters.
EnergyServicesListBySubscriptionOptionalParams	Optional parameters.
EnergyServicesUpdateOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Locations	Interface representing a Locations.
LocationsCheckNameAvailabilityOptionalParams	Optional parameters.
OpenEnergyPlatformManagementServiceAPIsOptionalParams	Optional parameters.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SystemData	Metadata pertaining to creation and last modification of the resource.

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
CheckNameAvailabilityReason	Defines values for CheckNameAvailabilityReason. KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid AlreadyExists
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
EnergyServicesCreateResponse	Contains response data for the create operation.
EnergyServicesGetResponse	Contains response data for the get operation.
EnergyServicesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
EnergyServicesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
EnergyServicesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
EnergyServicesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
EnergyServicesUpdateResponse	Contains response data for the update operation.
LocationsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Succeeded Failed Canceled Creating Deleting Updating

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownCheckNameAvailabilityReason	Known values of CheckNameAvailabilityReason that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().