Microsoft Azure OEPResourcePartition API

openapi: 3.2.0
info:
  title: Microsoft Azure Open Energy Platform Management Service OEP…
  description: Open Energy Platform Management Service APIs
  version: 2022-04-04-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: OEPResourcePartition
paths:
  ? /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
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: The data partitions will be created asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPartitionAddOrRemoveRequest'
        default:
          description: Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger could not be created/updated)
          content:
            application/json:
              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…
      requestBody:
        content:
          application/json:
            schema:
              description: Request body.
              $ref: '#/components/schemas/DataPartitionAddOrRemoveRequest'
        description: add partition action payload
  ? /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
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: The data partitions will be deleted asynchronously
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPartitionAddOrRemoveRequest'
        default:
          description: Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger could not be created/updated)
          content:
            application/json:
              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…
      requestBody:
        content:
          application/json:
            schema:
              description: Request body.
              $ref: '#/components/schemas/DataPartitionAddOrRemoveRequest'
        description: remove partition action payload
  ? /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
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPartitionsListResult'
        default:
          description: Error response describing the reason for operation failure. 404 - NotFound (Confidential Ledger could not be created/updated)
          content:
            application/json:
              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…
components:
  schemas:
    DataPartitionNames:
      type: object
      description: The list of Energy services resource's Data Partition Names.
      properties:
        name:
          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: '#/components/schemas/DataPartitionProperties'
          x-ms-identifiers: []
    DataPartitionAddOrRemoveRequest:
      description: Defines the partition add/ delete action properties.
      type: object
      properties:
        name:
          $ref: '#/components/schemas/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
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow