The Microsoft Azure Open Energy Platform Management Service APIs provide developers with a set of tools and resources to efficiently manage and integrate energy data within their applications. These APIs allow users to access real-time energy consumption information, analyze historical data, and make informed decisions to optimize energy usage and reduce costs.
swagger: '2.0'
info:
title: Microsoft Azure Open Energy Platform Management Service APIs
description: Open Energy Platform Management Service APIs
version: 2022-04-04-preview
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.OpenEnergyPlatform/checkNameAvailability:
post:
tags:
- Locations
description: >-
Checks the name availability of the resource with requested resource
name.
operationId: microsoftAzureLocationsChecknameavailability
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- in: body
name: body
description: NameAvailabilityRequest object.
required: true
schema:
description: NameAvailabilityRequest object.
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest
responses:
'200':
description: Success
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse
default:
description: Error
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Locations_CheckNameAvailability:
$ref: ./examples/Locations_CheckNameAvailability.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Openenergyplatform Checknameavailability
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices:
get:
tags:
- UserRPOepResource
description: Returns list of oep resources..
operationId: microsoftAzureEnergyservicesListbyresourcegroup
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/EnergyServiceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
OepResource_ListByResourceGroup:
$ref: ./examples/OepResource_ListByResourceGroup.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices
/subscriptions/{subscriptionId}/providers/Microsoft.OpenEnergyPlatform/energyServices:
get:
tags:
- UserRPOepResource
description: >-
Lists a collection of oep resources under the given Azure Subscription
ID.
operationId: microsoftAzureEnergyservicesListbysubscription
x-ms-examples:
OepResource_ListBySubscriptionId:
$ref: ./examples/OepResource_ListBySubscriptionId.json
x-ms-pageable:
nextLinkName: nextLink
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Returned when the operation is successful.
schema:
$ref: '#/definitions/EnergyServiceList'
default:
x-nullable: false
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Openenergyplatform Energyservices
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}
: get:
tags:
- UserRPOepResource
description: Returns oep resource for a given name.
operationId: microsoftAzureEnergyservicesGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- in: path
name: resourceName
description: The resource name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/EnergyService'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
OepResource_Get:
$ref: ./examples/OepResource_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename
put:
tags:
- UserRPOepResource
description: Method that gets called if subscribed for ResourceCreationBegin trigger.
operationId: microsoftAzureEnergyservicesCreate
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- in: path
name: resourceName
description: The resource name.
required: true
type: string
- in: body
name: body
description: Request body.
schema:
description: Request body.
$ref: '#/definitions/EnergyService'
responses:
'200':
description: The OEP resource created.
schema:
$ref: '#/definitions/EnergyService'
'201':
description: The OEP resource will be created asynchronously
schema:
$ref: '#/definitions/EnergyService'
default:
description: >-
Error response describing the reason for operation failure. 404 -
NotFound (Confidential Ledger could not be created/updated)
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
OepResource_Create:
$ref: ./examples/OepResource_Create.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename
patch:
operationId: microsoftAzureEnergyservicesUpdate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- in: path
name: resourceName
description: The resource name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- in: body
name: body
schema:
$ref: '#/definitions/EnergyResourceUpdate'
responses:
'200':
description: Updates the oep resource.
schema:
$ref: '#/definitions/EnergyService'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
OepResource_Update:
$ref: ./examples/OepResource_Update.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename
description: Needs a more full description created.
tags:
- Subscriptions
delete:
description: Deletes oep resource
operationId: microsoftAzureEnergyservicesDelete
x-ms-long-running-operation: true
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- in: path
name: resourceName
description: The resource name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
'202':
description: The OEP resource will be deleted asynchronously
'204':
description: Returned when the operation returns no content.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
OepResource_Delete:
$ref: ./examples/OepResource_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}/addPartition
: post:
tags:
- OEPResourcePartition
description: Method that gets called if new partition is to be added in a resource.
operationId: microsoftAzureEnergyservicesAddpartition
x-ms-long-running-operation: true
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- in: path
name: resourceName
description: The resource name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- in: body
name: body
description: add partition action payload
schema:
description: Request body.
$ref: '#/definitions/DataPartitionAddOrRemoveRequest'
responses:
'202':
description: The data partitions will be created asynchronously
schema:
$ref: '#/definitions/DataPartitionAddOrRemoveRequest'
default:
description: >-
Error response describing the reason for operation failure. 404 -
NotFound (Confidential Ledger could not be created/updated)
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
EnergyServices_AddPartition_MaximumSet_Gen:
$ref: ./examples/EnergyServices_AddPartition_MaximumSet_Gen.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename Addpartition
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}/removePartition
: post:
tags:
- OEPResourcePartition
description: >-
Method that gets called if new partition is to be removed from a
resource.
operationId: microsoftAzureEnergyservicesRemovepartition
x-ms-long-running-operation: true
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- in: path
name: resourceName
description: The resource name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- in: body
name: body
description: remove partition action payload
schema:
description: Request body.
$ref: '#/definitions/DataPartitionAddOrRemoveRequest'
responses:
'202':
description: The data partitions will be deleted asynchronously
schema:
$ref: '#/definitions/DataPartitionAddOrRemoveRequest'
default:
description: >-
Error response describing the reason for operation failure. 404 -
NotFound (Confidential Ledger could not be created/updated)
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
EnergyServices_RemovePartition_MaximumSet_Gen:
$ref: ./examples/EnergyServices_RemovePartition_MaximumSet_Gen.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename Removepartition
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}/listPartitions
: post:
tags:
- OEPResourcePartition
description: Method that gets called when list of partitions is requested.
operationId: microsoftAzureEnergyservicesListpartitions
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- in: path
name: resourceName
description: The resource name.
required: true
type: string
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: '#/definitions/DataPartitionsListResult'
default:
description: >-
Error response describing the reason for operation failure. 404 -
NotFound (Confidential Ledger could not be created/updated)
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
EnergyServices_ListPartitions_MaximumSet_Gen:
$ref: ./examples/EnergyServices_ListPartitions_MaximumSet_Gen.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Openenergyplatform Energyservices Resourcename Listpartitions
/providers/Microsoft.OpenEnergyPlatform/operations:
get:
tags:
- Operations
description: >-
Lists the available operations of Microsoft.OpenEnergyPlatform resource
provider.
operationId: microsoftAzureOperationsList
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Operations_List:
$ref: ./examples/Operations_List.json
summary: Microsoft Azure Get Providers Microsoft Openenergyplatform Operations
parameters:
DataPartitionIdParameter:
name: dataPartitionId
in: path
required: true
type: string
description: The data partition id.
x-ms-parameter-location: method
definitions:
EnergyServiceList:
description: The list of oep resources.
type: object
properties:
nextLink:
description: The link used to get the next page of oep resources list.
type: string
value:
description: The list of oep resources.
type: array
items:
$ref: '#/definitions/EnergyService'
DataPartitionsList:
type: object
description: List of data partitions
properties:
dataPartitionNames:
type: array
items:
$ref: '#/definitions/DataPartitionNames'
x-ms-identifiers: []
DataPartitionNames:
type: object
description: The list of Energy services resource's Data Partition Names.
properties:
name:
type: string
DataPartitionAddOrRemoveRequest:
description: Defines the partition add/ delete action properties.
type: object
properties:
name:
$ref: '#/definitions/DataPartitionNames'
DataPartitionProperties:
description: Defines the properties of an individual data partition.
type: object
properties:
name:
description: Name of the data partition
type: string
provisioningState:
description: Name of the data partition
type: string
DataPartitionsListResult:
type: object
description: List of data partitions.
properties:
dataPartitionInfo:
type: array
description: >-
List of data partitions along with their properties in a given OEP
resource.
items:
$ref: '#/definitions/DataPartitionProperties'
x-ms-identifiers: []
EnergyServiceProperties:
type: object
properties:
dnsName:
type: string
readOnly: true
provisioningState:
enum:
- Unknown
- Succeeded
- Failed
- Canceled
- Creating
- Deleting
- Updating
type: string
readOnly: true
x-ms-enum:
name: ProvisioningState
modelAsString: true
authAppId:
type: string
readOnly: false
dataPartitionNames:
type: array
items:
$ref: '#/definitions/DataPartitionNames'
x-ms-identifiers: []
EnergyService:
required:
- location
type: object
allOf:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
properties:
properties:
$ref: '#/definitions/EnergyServiceProperties'
tags:
description: Resource tags.
type: object
additionalProperties:
type: string
location:
description: Geo-location where the resource lives.
type: string
EnergyResourceUpdate:
description: The resource model definition used for updating a tracked ARM resource.
type: object
properties:
tags:
description: Resource tags.
type: object
additionalProperties:
type: string
securityDefinitions:
azure_auth:
type: oauth2
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account
description: Azure Active Directory OAuth2 Flow
security:
- azure_auth:
- user_impersonation
consumes:
- application/json
produces:
- application/json
host: management.azure.com
schemes:
- https
tags:
- name: Locations
- name: OEPResourcePartition
- name: Operations
- name: Subscriptions
- name: UserRPOepResource