Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-oep

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ActionType

ActionType: string

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

CheckNameAvailabilityReason: string

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

CreatedByType: string

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

EnergyService

EnergyService: Resource & { location: string; properties?: EnergyServiceProperties; tags?: undefined | {} }

EnergyServicesCreateResponse

EnergyServicesCreateResponse: EnergyService

Contains response data for the create operation.

EnergyServicesGetResponse

EnergyServicesGetResponse: EnergyService

Contains response data for the get operation.

EnergyServicesListByResourceGroupNextResponse

EnergyServicesListByResourceGroupNextResponse: EnergyServiceList

Contains response data for the listByResourceGroupNext operation.

EnergyServicesListByResourceGroupResponse

EnergyServicesListByResourceGroupResponse: EnergyServiceList

Contains response data for the listByResourceGroup operation.

EnergyServicesListBySubscriptionNextResponse

EnergyServicesListBySubscriptionNextResponse: EnergyServiceList

Contains response data for the listBySubscriptionNext operation.

EnergyServicesListBySubscriptionResponse

EnergyServicesListBySubscriptionResponse: EnergyServiceList

Contains response data for the listBySubscription operation.

EnergyServicesUpdateResponse

EnergyServicesUpdateResponse: EnergyService

Contains response data for the update operation.

LocationsCheckNameAvailabilityResponse

LocationsCheckNameAvailabilityResponse: CheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

OperationsListResponse

OperationsListResponse: OperationListResult

Contains response data for the list operation.

Origin

Origin: string

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

ProvisioningState: string

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

Variables

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Object literals

Const $host

$host: object

parameterPath

parameterPath: string = "$host"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "$host"

type

type: object

name

name: string = "String"

Const CheckNameAvailabilityRequest

CheckNameAvailabilityRequest: object

type

type: object

className

className: string = "CheckNameAvailabilityRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const CheckNameAvailabilityResponse

CheckNameAvailabilityResponse: object

type

type: object

className

className: string = "CheckNameAvailabilityResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

nameAvailable

nameAvailable: object

serializedName

serializedName: string = "nameAvailable"

type

type: object

name

name: string = "Boolean"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: string = "String"

Const DataPartitionNames

DataPartitionNames: object

type

type: object

className

className: string = "DataPartitionNames"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const EnergyResourceUpdate

EnergyResourceUpdate: object

type

type: object

className

className: string = "EnergyResourceUpdate"

name

name: string = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const EnergyService

EnergyService: object

type

type: object

className

className: string = "EnergyService"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

required

required: boolean = true

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "EnergyServiceProperties"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const EnergyServiceList

EnergyServiceList: object

type

type: object

className

className: string = "EnergyServiceList"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EnergyService"

name

name: string = "Composite"

Const EnergyServiceProperties

EnergyServiceProperties: object

type

type: object

className

className: string = "EnergyServiceProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

authAppId

authAppId: object

serializedName

serializedName: string = "authAppId"

type

type: object

name

name: string = "String"

dataPartitionNames

dataPartitionNames: object

serializedName

serializedName: string = "dataPartitionNames"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "DataPartitionNames"

name

name: string = "Composite"

dnsName

dnsName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "dnsName"

type

type: object

name

name: string = "String"

provisioningState

provisioningState: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: string = "String"

Const ErrorAdditionalInfo

ErrorAdditionalInfo: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

info

info: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "info"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "any"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const ErrorDetail

ErrorDetail: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

modelProperties

modelProperties: object

additionalInfo

additionalInfo: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "additionalInfo"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

Const Operation

Operation: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

modelProperties

modelProperties: object

actionType

actionType: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "actionType"

type

type: object

name

name: string = "String"

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

isDataAction

isDataAction: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "isDataAction"

type

type: object

name

name: string = "Boolean"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

origin

origin: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "origin"

type

type: object

name

name: string = "String"

Const OperationDisplay

OperationDisplay: object

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

operation

operation: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: string = "String"

provider

provider: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

resource

resource: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "resource"

type

type: object

name

name: string = "String"

Const OperationListResult

OperationListResult: object

type

type: object

className

className: string = "OperationListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

Const Resource

Resource: object

type

type: object

className

className: string = "Resource"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

systemData

systemData: object

serializedName

serializedName: string = "systemData"

type

type: object

className

className: string = "SystemData"

name

name: string = "Composite"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const SystemData

SystemData: object

type

type: object

className

className: string = "SystemData"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdAt

createdAt: object

serializedName

serializedName: string = "createdAt"

type

type: object

name

name: string = "DateTime"

createdBy

createdBy: object

serializedName

serializedName: string = "createdBy"

type

type: object

name

name: string = "String"

createdByType

createdByType: object

serializedName

serializedName: string = "createdByType"

type

type: object

name

name: string = "String"

lastModifiedAt

lastModifiedAt: object

serializedName

serializedName: string = "lastModifiedAt"

type

type: object

name

name: string = "DateTime"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "lastModifiedBy"

type

type: object

name

name: string = "String"

lastModifiedByType

lastModifiedByType: object

serializedName

serializedName: string = "lastModifiedByType"

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-06-01-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const body

body: object

mapper

mapper: any = CheckNameAvailabilityRequestMapper

parameterPath

parameterPath: string = "body"

Const body1

body1: object

mapper

mapper: any = EnergyServiceMapper

parameterPath

parameterPath: string[] = ["options", "body"]

Const body2

body2: object

mapper

mapper: any = EnergyResourceUpdateMapper

parameterPath

parameterPath: string[] = ["options", "body"]

Const checkNameAvailabilityOperationSpec

checkNameAvailabilityOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.OpenEnergyPlatform/checkNameAvailability"

requestBody

requestBody: any = Parameters.body

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.subscriptionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CheckNameAvailabilityResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const createOperationSpec

createOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}"

requestBody

requestBody: any = Parameters.body1

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.EnergyService

201

201: object

bodyMapper

bodyMapper: any = Mappers.EnergyService

202

202: object

bodyMapper

bodyMapper: any = Mappers.EnergyService

204

204: object

bodyMapper

bodyMapper: any = Mappers.EnergyService

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const deleteOperationSpec

deleteOperationSpec: object

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName]

responses

responses: object

200

200: {}

Type declaration

201

201: {}

Type declaration

202

202: {}

Type declaration

204

204: {}

Type declaration

default

default: {}

Type declaration

Const getOperationSpec

getOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.EnergyService

Const listByResourceGroupNextOperationSpec

listByResourceGroupNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.nextLink]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.EnergyServiceList

Const listByResourceGroupOperationSpec

listByResourceGroupOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.EnergyServiceList

Const listBySubscriptionNextOperationSpec

listBySubscriptionNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.nextLink]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.EnergyServiceList

Const listBySubscriptionOperationSpec

listBySubscriptionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.OpenEnergyPlatform/energyServices"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.subscriptionId]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.EnergyServiceList

Const listOperationSpec

listOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/providers/Microsoft.OpenEnergyPlatform/operations"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.OperationListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const resourceName

resourceName: object

parameterPath

parameterPath: string = "resourceName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resourceName"

type

type: object

name

name: string = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "subscriptionId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const updateOperationSpec

updateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.contentType, Parameters.accept]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OpenEnergyPlatform/energyServices/{resourceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.body2

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName]

responses

responses: object

default

default: {}

Type declaration

200

200: object

bodyMapper

bodyMapper: any = Mappers.EnergyService

Generated using TypeDoc