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 AzureDataExplorerConnectionProperties
AzureDataExplorerConnectionProperties: object
serializedName
serializedName: string = "AzureDataExplorer"
type
type: object
className
className: string = "AzureDataExplorerConnectionProperties"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = TimeSeriesDatabaseConnectionProperties.type.polymorphicDiscriminator
uberParent
uberParent: string = "TimeSeriesDatabaseConnectionProperties"
modelProperties
modelProperties: object
adxDatabaseName
adxDatabaseName: object
required
required: boolean = true
serializedName
serializedName: string = "adxDatabaseName"
type
type: object
name
name: string = "String"
adxEndpointUri
adxEndpointUri: object
required
required: boolean = true
serializedName
serializedName: string = "adxEndpointUri"
type
type: object
name
name: string = "String"
adxResourceId
adxResourceId: object
required
required: boolean = true
serializedName
serializedName: string = "adxResourceId"
type
type: object
name
name: string = "String"
adxTableName
adxTableName: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "adxTableName"
type
type: object
name
name: string = "String"
eventHubConsumerGroup
eventHubConsumerGroup: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "eventHubConsumerGroup"
type
type: object
name
name: string = "String"
eventHubEndpointUri
eventHubEndpointUri: object
required
required: boolean = true
serializedName
serializedName: string = "eventHubEndpointUri"
type
type: object
name
name: string = "String"
eventHubEntityPath
eventHubEntityPath: object
required
required: boolean = true
serializedName
serializedName: string = "eventHubEntityPath"
type
type: object
name
name: string = "String"
eventHubNamespaceResourceId
eventHubNamespaceResourceId: object
required
required: boolean = true
serializedName
serializedName: string = "eventHubNamespaceResourceId"
type
type: object
name
name: string = "String"
Const CheckNameRequest
CheckNameRequest: object
type
type: object
className
className: string = "CheckNameRequest"
name
name: string = "Composite"
modelProperties
modelProperties: object
name
name: object
required
required: boolean = true
serializedName
serializedName: string = "name"
type
type: object
name
name: string = "String"
type
type: object
defaultValue
defaultValue: string = "Microsoft.DigitalTwins/digitalTwinsInstances"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "type"
type
type: object
name
name: string = "String"
Const CheckNameResult
CheckNameResult: object
type
type: object
className
className: string = "CheckNameResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
message
message: object
nullable
nullable: boolean = true
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
nullable
nullable: boolean = true
serializedName
serializedName: string = "reason"
type
type: object
name
name: string = "String"
Const ConnectionProperties
ConnectionProperties: object
type
type: object
className
className: string = "ConnectionProperties"
name
name: string = "Composite"
modelProperties
modelProperties: object
groupIds
groupIds: object
serializedName
serializedName: string = "groupIds"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
privateEndpoint
privateEndpoint: object
serializedName
serializedName: string = "privateEndpoint"
type
type: object
className
className: string = "PrivateEndpoint"
name
name: string = "Composite"
privateLinkServiceConnectionState
privateLinkServiceConnectionState: object
serializedName
serializedName: string = "privateLinkServiceConnectionState"
type
type: object
className
className: string = "ConnectionPropertiesPrivateLinkServiceConnectionState"
name
name: string = "Composite"
provisioningState
provisioningState: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "provisioningState"
type
type: object
name
name: string = "String"
Const ConnectionPropertiesPrivateLinkServiceConnectionState
ConnectionPropertiesPrivateLinkServiceConnectionState: object
type
type: object
className
className: string = "ConnectionPropertiesPrivateLinkServiceConnectionState"
name
name: string = "Composite"
modelProperties
modelProperties: object
Const ConnectionState
ConnectionState: object
type
type: object
className
className: string = "ConnectionState"
name
name: string = "Composite"
modelProperties
modelProperties: object
actionsRequired
actionsRequired: object
serializedName
serializedName: string = "actionsRequired"
type
type: object
name
name: string = "String"
description
description: object
required
required: boolean = true
serializedName
serializedName: string = "description"
type
type: object
name
name: string = "String"
status
status: object
required
required: boolean = true
serializedName
serializedName: string = "status"
type
type: object
name
name: string = "String"
Const DigitalTwinsDescription
DigitalTwinsDescription: object
type
type: object
className
className: string = "DigitalTwinsDescription"
name
name: string = "Composite"
modelProperties
modelProperties: object
createdTime
createdTime: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "properties.createdTime"
type
type: object
name
name: string = "DateTime"
hostName
hostName: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "properties.hostName"
type
type: object
name
name: string = "String"
lastUpdatedTime
lastUpdatedTime: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "properties.lastUpdatedTime"
type
type: object
name
name: string = "DateTime"
privateEndpointConnections
privateEndpointConnections: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "properties.privateEndpointConnections"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "PrivateEndpointConnection"
name
name: string = "Composite"
provisioningState
provisioningState: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "properties.provisioningState"
type
type: object
name
name: string = "String"
publicNetworkAccess
publicNetworkAccess: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "properties.publicNetworkAccess"
type
type: object
name
name: string = "String"
Const DigitalTwinsDescriptionListResult
DigitalTwinsDescriptionListResult: object
type
type: object
className
className: string = "DigitalTwinsDescriptionListResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
nullable
nullable: boolean = true
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 = "DigitalTwinsDescription"
name
name: string = "Composite"
Const DigitalTwinsEndpointResource
DigitalTwinsEndpointResource: object
type
type: object
className
className: string = "DigitalTwinsEndpointResource"
name
name: string = "Composite"
modelProperties
modelProperties: object
properties
properties: object
serializedName
serializedName: string = "properties"
type
type: object
className
className: string = "DigitalTwinsEndpointResourceProperties"
name
name: string = "Composite"
Const DigitalTwinsEndpointResourceListResult
DigitalTwinsEndpointResourceListResult: object
type
type: object
className
className: string = "DigitalTwinsEndpointResourceListResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
nullable
nullable: boolean = true
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 = "DigitalTwinsEndpointResource"
name
name: string = "Composite"
Const DigitalTwinsEndpointResourceProperties
DigitalTwinsEndpointResourceProperties: object
type
type: object
className
className: string = "DigitalTwinsEndpointResourceProperties"
name
name: string = "Composite"
uberParent
uberParent: string = "DigitalTwinsEndpointResourceProperties"
modelProperties
modelProperties: object
authenticationType
authenticationType: object
serializedName
serializedName: string = "authenticationType"
type
type: object
name
name: string = "String"
createdTime
createdTime: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "createdTime"
type
type: object
name
name: string = "DateTime"
deadLetterSecret
deadLetterSecret: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "deadLetterSecret"
type
type: object
name
name: string = "String"
deadLetterUri
deadLetterUri: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "deadLetterUri"
type
type: object
name
name: string = "String"
endpointType
endpointType: object
required
required: boolean = true
serializedName
serializedName: string = "endpointType"
type
type: object
name
name: string = "String"
provisioningState
provisioningState: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "provisioningState"
type
type: object
name
name: string = "String"
polymorphicDiscriminator
polymorphicDiscriminator: object
clientName
clientName: string = "endpointType"
serializedName
serializedName: string = "endpointType"
Const DigitalTwinsIdentity
DigitalTwinsIdentity: object
type
type: object
className
className: string = "DigitalTwinsIdentity"
name
name: string = "Composite"
modelProperties
modelProperties: object
principalId
principalId: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "principalId"
type
type: object
name
name: string = "String"
tenantId
tenantId: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "tenantId"
type
type: object
name
name: string = "String"
type
type: object
serializedName
serializedName: string = "type"
type
type: object
name
name: string = "String"
Const DigitalTwinsPatchDescription
DigitalTwinsPatchDescription: object
type
type: object
className
className: string = "DigitalTwinsPatchDescription"
name
name: string = "Composite"
modelProperties
modelProperties: object
identity
identity: object
serializedName
serializedName: string = "identity"
type
type: object
className
className: string = "DigitalTwinsIdentity"
name
name: string = "Composite"
properties
properties: object
serializedName
serializedName: string = "properties"
type
type: object
className
className: string = "DigitalTwinsPatchProperties"
name
name: string = "Composite"
tags
tags: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "tags"
type
type: object
name
name: string = "Dictionary"
value
value: object
type
type: object
name
name: string = "String"
Const DigitalTwinsPatchProperties
DigitalTwinsPatchProperties: object
type
type: object
className
className: string = "DigitalTwinsPatchProperties"
name
name: string = "Composite"
modelProperties
modelProperties: object
publicNetworkAccess
publicNetworkAccess: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "publicNetworkAccess"
type
type: object
name
name: string = "String"
Const DigitalTwinsResource
DigitalTwinsResource: object
type
type: object
className
className: string = "DigitalTwinsResource"
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"
identity
identity: object
serializedName
serializedName: string = "identity"
type
type: object
className
className: string = "DigitalTwinsIdentity"
name
name: string = "Composite"
location
location: object
required
required: boolean = true
serializedName
serializedName: string = "location"
type
type: object
name
name: string = "String"
name
name: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "name"
constraints
constraints: object
Pattern
Pattern: RegExp = new RegExp("^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$")
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"
tags
tags: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "tags"
type
type: object
name
name: string = "Dictionary"
value
value: object
type
type: object
name
name: string = "String"
type
type: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "type"
type
type: object
name
name: string = "String"
Const ErrorDefinition
ErrorDefinition: object
type
type: object
className
className: string = "ErrorDefinition"
name
name: string = "Composite"
modelProperties
modelProperties: object
code
code: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "code"
type
type: object
name
name: string = "String"
details
details: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "details"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "ErrorDefinition"
name
name: string = "Composite"
message
message: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "message"
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 = "ErrorDefinition"
name
name: string = "Composite"
Const EventGrid
EventGrid: object
serializedName
serializedName: string = "EventGrid"
type
type: object
className
className: string = "EventGrid"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = DigitalTwinsEndpointResourceProperties.type.polymorphicDiscriminator
uberParent
uberParent: string = "DigitalTwinsEndpointResourceProperties"
modelProperties
modelProperties: object
accessKey1
accessKey1: object
nullable
nullable: boolean = true
required
required: boolean = true
serializedName
serializedName: string = "accessKey1"
type
type: object
name
name: string = "String"
accessKey2
accessKey2: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "accessKey2"
type
type: object
name
name: string = "String"
topicEndpoint
topicEndpoint: object
required
required: boolean = true
serializedName
serializedName: string = "TopicEndpoint"
type
type: object
name
name: string = "String"
Const EventHub
EventHub: object
serializedName
serializedName: string = "EventHub"
type
type: object
className
className: string = "EventHub"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = DigitalTwinsEndpointResourceProperties.type.polymorphicDiscriminator
uberParent
uberParent: string = "DigitalTwinsEndpointResourceProperties"
modelProperties
modelProperties: object
connectionStringPrimaryKey
connectionStringPrimaryKey: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "connectionStringPrimaryKey"
type
type: object
name
name: string = "String"
connectionStringSecondaryKey
connectionStringSecondaryKey: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "connectionStringSecondaryKey"
type
type: object
name
name: string = "String"
endpointUri
endpointUri: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "endpointUri"
type
type: object
name
name: string = "String"
entityPath
entityPath: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "entityPath"
type
type: object
name
name: string = "String"
Const ExternalResource
ExternalResource: object
type
type: object
className
className: string = "ExternalResource"
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"
constraints
constraints: object
Pattern
Pattern: RegExp = new RegExp("^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$")
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 GroupIdInformation
GroupIdInformation: object
type
type: object
className
className: string = "GroupIdInformation"
name
name: string = "Composite"
modelProperties
modelProperties: object
id
id: object
serializedName
serializedName: string = "id"
type
type: object
name
name: string = "String"
name
name: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "name"
constraints
constraints: object
Pattern
Pattern: RegExp = new RegExp("^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$")
type
type: object
name
name: string = "String"
properties
properties: object
serializedName
serializedName: string = "properties"
type
type: object
className
className: string = "GroupIdInformationProperties"
name
name: string = "Composite"
type
type: object
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "type"
type
type: object
name
name: string = "String"
Const GroupIdInformationProperties
GroupIdInformationProperties: object
type
type: object
className
className: string = "GroupIdInformationProperties"
name
name: string = "Composite"
modelProperties
modelProperties: object
groupId
groupId: object
serializedName
serializedName: string = "groupId"
type
type: object
name
name: string = "String"
requiredMembers
requiredMembers: object
serializedName
serializedName: string = "requiredMembers"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
requiredZoneNames
requiredZoneNames: object
serializedName
serializedName: string = "requiredZoneNames"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
name
name: string = "String"
Const GroupIdInformationResponse
GroupIdInformationResponse: object
type
type: object
className
className: string = "GroupIdInformationResponse"
name
name: string = "Composite"
modelProperties
modelProperties: object
value
value: object
serializedName
serializedName: string = "value"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "GroupIdInformation"
name
name: string = "Composite"
Const Operation
Operation: object
type
type: object
className
className: string = "Operation"
name
name: string = "Composite"
modelProperties
modelProperties: object
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
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "origin"
type
type: object
name
name: string = "String"
properties
properties: object
nullable
nullable: boolean = true
readOnly
readOnly: boolean = true
serializedName
serializedName: string = "properties"
type
type: object
name
name: string = "Dictionary"
value
value: object
type
type: object
name
name: string = "Dictionary"
value
value: object
type
type: object
name
name: string = "any"
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
nullable
nullable: 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 PrivateEndpoint
PrivateEndpoint: object
type
type: object
className
className: string = "PrivateEndpoint"
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"
Const PrivateEndpointConnection
PrivateEndpointConnection: object
type
type: object
className
className: string = "PrivateEndpointConnection"
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"
constraints
constraints: object
Pattern
Pattern: RegExp = new RegExp("^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$")
type
type: object
name
name: string = "String"
properties
properties: object
serializedName
serializedName: string = "properties"
type
type: object
className
className: string = "ConnectionProperties"
name
name: string = "Composite"
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 PrivateEndpointConnectionsResponse
PrivateEndpointConnectionsResponse: object
type
type: object
className
className: string = "PrivateEndpointConnectionsResponse"
name
name: string = "Composite"
modelProperties
modelProperties: object
value
value: object
serializedName
serializedName: string = "value"
type
type: object
name
name: string = "Sequence"
element
element: object
type
type: object
className
className: string = "PrivateEndpointConnection"
name
name: string = "Composite"
Const ServiceBus
ServiceBus: object
serializedName
serializedName: string = "ServiceBus"
type
type: object
className
className: string = "ServiceBus"
name
name: string = "Composite"
polymorphicDiscriminator
polymorphicDiscriminator: any = DigitalTwinsEndpointResourceProperties.type.polymorphicDiscriminator
uberParent
uberParent: string = "DigitalTwinsEndpointResourceProperties"
modelProperties
modelProperties: object
endpointUri
endpointUri: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "endpointUri"
type
type: object
name
name: string = "String"
entityPath
entityPath: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "entityPath"
type
type: object
name
name: string = "String"
primaryConnectionString
primaryConnectionString: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "primaryConnectionString"
type
type: object
name
name: string = "String"
secondaryConnectionString
secondaryConnectionString: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "secondaryConnectionString"
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
nullable
nullable: boolean = true
serializedName
serializedName: string = "createdAt"
type
type: object
name
name: string = "DateTime"
createdBy
createdBy: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "createdBy"
type
type: object
name
name: string = "String"
createdByType
createdByType: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "createdByType"
type
type: object
name
name: string = "String"
lastModifiedAt
lastModifiedAt: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "lastModifiedAt"
type
type: object
name
name: string = "DateTime"
lastModifiedBy
lastModifiedBy: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "lastModifiedBy"
type
type: object
name
name: string = "String"
lastModifiedByType
lastModifiedByType: object
nullable
nullable: boolean = true
serializedName
serializedName: string = "lastModifiedByType"
type
type: object
name
name: string = "String"
Const TimeSeriesDatabaseConnection
TimeSeriesDatabaseConnection: object
type
type: object
className
className: string = "TimeSeriesDatabaseConnection"
name
name: string = "Composite"
modelProperties
modelProperties: object
properties
properties: object
serializedName
serializedName: string = "properties"
type
type: object
className
className: string = "TimeSeriesDatabaseConnectionProperties"
name
name: string = "Composite"
Const TimeSeriesDatabaseConnectionListResult
TimeSeriesDatabaseConnectionListResult: object
type
type: object
className
className: string = "TimeSeriesDatabaseConnectionListResult"
name
name: string = "Composite"
modelProperties
modelProperties: object
nextLink
nextLink: object
nullable
nullable: boolean = true
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 = "TimeSeriesDatabaseConnection"
name
name: string = "Composite"
Const TimeSeriesDatabaseConnectionProperties
TimeSeriesDatabaseConnectionProperties: object
type
type: object
className
className: string = "TimeSeriesDatabaseConnectionProperties"
name
name: string = "Composite"
uberParent
uberParent: string = "TimeSeriesDatabaseConnectionProperties"
modelProperties
modelProperties: object
connectionType
connectionType: object
required
required: boolean = true
serializedName
serializedName: string = "connectionType"
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"
polymorphicDiscriminator
polymorphicDiscriminator: object
clientName
clientName: string = "connectionType"
serializedName
serializedName: string = "connectionType"
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-30-preview"
isConstant
isConstant: boolean = true
serializedName
serializedName: string = "api-version"
type
type: object
name
name: string = "String"
Const checkNameAvailabilityOperationSpec
checkNameAvailabilityOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType]
httpMethod
httpMethod: string = "POST"
mediaType
mediaType: string = "json"
path
path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.digitalTwinsInstanceCheckName
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.location]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.CheckNameResult
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 createOrUpdateOperationSpec
createOrUpdateOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType]
httpMethod
httpMethod: string = "PUT"
mediaType
mediaType: string = "json"
path
path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.timeSeriesDatabaseConnectionDescription
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName,Parameters.timeSeriesDatabaseConnectionName]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
201
201: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
202
202: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
204
204: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const deleteOperationSpec
deleteOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "DELETE"
path
path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName,Parameters.timeSeriesDatabaseConnectionName]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
201
201: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
202
202: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
204
204: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const digitalTwinsCreate
digitalTwinsCreate: object
mapper
mapper: any = DigitalTwinsDescriptionMapper
parameterPath
parameterPath: string = "digitalTwinsCreate"
Const digitalTwinsInstanceCheckName
digitalTwinsInstanceCheckName: object
mapper
mapper: any = CheckNameRequestMapper
parameterPath
parameterPath: string = "digitalTwinsInstanceCheckName"
Const digitalTwinsPatchDescription
digitalTwinsPatchDescription: object
mapper
mapper: any = DigitalTwinsPatchDescriptionMapper
parameterPath
parameterPath: string = "digitalTwinsPatchDescription"
Let discriminators
discriminators: object
DigitalTwinsEndpointResourceProperties
DigitalTwinsEndpointResourceProperties: any = DigitalTwinsEndpointResourceProperties
DigitalTwinsEndpointResourceProperties.EventGrid
DigitalTwinsEndpointResourceProperties.EventGrid: any = EventGrid
DigitalTwinsEndpointResourceProperties.EventHub
DigitalTwinsEndpointResourceProperties.EventHub: any = EventHub
DigitalTwinsEndpointResourceProperties.ServiceBus
DigitalTwinsEndpointResourceProperties.ServiceBus: any = ServiceBus
TimeSeriesDatabaseConnectionProperties
TimeSeriesDatabaseConnectionProperties: any = TimeSeriesDatabaseConnectionProperties
TimeSeriesDatabaseConnectionProperties.AzureDataExplorer
TimeSeriesDatabaseConnectionProperties.AzureDataExplorer: any = AzureDataExplorerConnectionProperties
Const endpointDescription
endpointDescription: object
mapper
mapper: any = DigitalTwinsEndpointResourceMapper
parameterPath
parameterPath: string = "endpointDescription"
Const endpointName
endpointName: object
parameterPath
parameterPath: string = "endpointName"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "endpointName"
constraints
constraints: object
MaxLength
MaxLength: number = 49
MinLength
MinLength: number = 2
Pattern
Pattern: RegExp = new RegExp("^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$")
type
type: object
name
name: string = "String"
Const getOperationSpec
getOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName,Parameters.timeSeriesDatabaseConnectionName]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnection
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
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
200
200: object
bodyMapper
bodyMapper: any = Mappers.DigitalTwinsDescriptionListResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const listByResourceGroupOperationSpec
listByResourceGroupOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.DigitalTwinsDescriptionListResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const listNextOperationSpec
listNextOperationSpec: 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.resourceName,Parameters.nextLink]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnectionListResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const listOperationSpec
listOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept]
httpMethod
httpMethod: string = "GET"
path
path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.TimeSeriesDatabaseConnectionListResult
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Const location
location: object
parameterPath
parameterPath: string = "location"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "location"
constraints
constraints: object
MinLength
MinLength: number = 3
type
type: object
name
name: string = "String"
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 privateEndpointConnection
privateEndpointConnection: object
mapper
mapper: any = PrivateEndpointConnectionMapper
parameterPath
parameterPath: string = "privateEndpointConnection"
Const privateEndpointConnectionName
privateEndpointConnectionName: object
parameterPath
parameterPath: string = "privateEndpointConnectionName"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "privateEndpointConnectionName"
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 resourceId
resourceId: object
parameterPath
parameterPath: string = "resourceId"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "resourceId"
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"
constraints
constraints: object
MaxLength
MaxLength: number = 63
MinLength
MinLength: number = 3
Pattern
Pattern: RegExp = new RegExp("^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$")
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"
type
type: object
name
name: string = "String"
Const timeSeriesDatabaseConnectionDescription
timeSeriesDatabaseConnectionDescription: object
mapper
mapper: any = TimeSeriesDatabaseConnectionMapper
parameterPath
parameterPath: string = "timeSeriesDatabaseConnectionDescription"
Const timeSeriesDatabaseConnectionName
timeSeriesDatabaseConnectionName: object
parameterPath
parameterPath: string = "timeSeriesDatabaseConnectionName"
mapper
mapper: object
required
required: boolean = true
serializedName
serializedName: string = "timeSeriesDatabaseConnectionName"
constraints
constraints: object
MaxLength
MaxLength: number = 49
MinLength
MinLength: number = 2
Pattern
Pattern: RegExp = new RegExp("^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$")
type
type: object
name
name: string = "String"
Const updateOperationSpec
updateOperationSpec: object
headerParameters
headerParameters: any[] = [Parameters.accept, Parameters.contentType]
httpMethod
httpMethod: string = "PATCH"
mediaType
mediaType: string = "json"
path
path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}"
queryParameters
queryParameters: any[] = [Parameters.apiVersion]
requestBody
requestBody: any = Parameters.digitalTwinsPatchDescription
serializer
serializer: any
urlParameters
urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.resourceName]
responses
responses: object
200
200: object
bodyMapper
bodyMapper: any = Mappers.DigitalTwinsDescription
201
201: object
bodyMapper
bodyMapper: any = Mappers.DigitalTwinsDescription
202
202: object
bodyMapper
bodyMapper: any = Mappers.DigitalTwinsDescription
204
204: object
bodyMapper
bodyMapper: any = Mappers.DigitalTwinsDescription
default
default: object
bodyMapper
bodyMapper: any = Mappers.ErrorResponse
Defines values for AuthenticationType.
KnownAuthenticationType can be used interchangeably with AuthenticationType, this enum contains the known values that the service supports.
Known values supported by the service
KeyBased
IdentityBased