Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-iotcentral

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

App

App: TrackedResource & { applicationId?: undefined | string; displayName?: undefined | string; identity?: SystemAssignedServiceIdentity; networkRuleSets?: NetworkRuleSets; privateEndpointConnections?: PrivateEndpointConnection[]; provisioningState?: ProvisioningState; publicNetworkAccess?: PublicNetworkAccess; sku: AppSkuInfo; state?: AppState; subdomain?: undefined | string; template?: undefined | string }

The IoT Central application.

AppSku

AppSku: string

Defines values for AppSku.
KnownAppSku can be used interchangeably with AppSku, this enum contains the known values that the service supports.

Known values supported by the service

ST0
ST1
ST2

AppState

AppState: string

Defines values for AppState.
KnownAppState can be used interchangeably with AppState, this enum contains the known values that the service supports.

Known values supported by the service

created
suspended

AppsCheckNameAvailabilityResponse

AppsCheckNameAvailabilityResponse: AppAvailabilityInfo

Contains response data for the checkNameAvailability operation.

AppsCheckSubdomainAvailabilityResponse

AppsCheckSubdomainAvailabilityResponse: AppAvailabilityInfo

Contains response data for the checkSubdomainAvailability operation.

AppsCreateOrUpdateResponse

AppsCreateOrUpdateResponse: AppsCreateOrUpdateHeaders & App

Contains response data for the createOrUpdate operation.

AppsDeleteResponse

AppsDeleteResponse: AppsDeleteHeaders

Contains response data for the delete operation.

AppsGetResponse

AppsGetResponse: App

Contains response data for the get operation.

AppsListByResourceGroupNextResponse

AppsListByResourceGroupNextResponse: AppListResult

Contains response data for the listByResourceGroupNext operation.

AppsListByResourceGroupResponse

AppsListByResourceGroupResponse: AppListResult

Contains response data for the listByResourceGroup operation.

AppsListBySubscriptionNextResponse

AppsListBySubscriptionNextResponse: AppListResult

Contains response data for the listBySubscriptionNext operation.

AppsListBySubscriptionResponse

AppsListBySubscriptionResponse: AppListResult

Contains response data for the listBySubscription operation.

AppsListTemplatesNextResponse

AppsListTemplatesNextResponse: AppTemplatesResult

Contains response data for the listTemplatesNext operation.

AppsListTemplatesResponse

AppsListTemplatesResponse: AppTemplatesResult

Contains response data for the listTemplates operation.

AppsUpdateResponse

AppsUpdateResponse: AppsUpdateHeaders

Contains response data for the update operation.

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

NetworkAction

NetworkAction: string

Defines values for NetworkAction.
KnownNetworkAction can be used interchangeably with NetworkAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow
Deny

OperationsListNextResponse

OperationsListNextResponse: OperationListResult

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult

Contains response data for the list operation.

PrivateEndpointConnection

PrivateEndpointConnection: Resource & { groupIds?: string[]; privateEndpoint?: PrivateEndpoint; privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState; provisioningState?: PrivateEndpointConnectionProvisioningState }

The private endpoint connection resource.

PrivateEndpointConnectionProvisioningState

PrivateEndpointConnectionProvisioningState: string

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionsCreateResponse

PrivateEndpointConnectionsCreateResponse: PrivateEndpointConnectionsCreateHeaders & PrivateEndpointConnection

Contains response data for the create operation.

PrivateEndpointConnectionsDeleteResponse

PrivateEndpointConnectionsDeleteResponse: PrivateEndpointConnectionsDeleteHeaders

Contains response data for the delete operation.

PrivateEndpointConnectionsGetResponse

PrivateEndpointConnectionsGetResponse: PrivateEndpointConnection

Contains response data for the get operation.

PrivateEndpointConnectionsListResponse

PrivateEndpointConnectionsListResponse: PrivateEndpointConnectionListResult

Contains response data for the list operation.

PrivateEndpointServiceConnectionStatus

PrivateEndpointServiceConnectionStatus: string

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

PrivateLinkResource

PrivateLinkResource: Resource & { groupId?: undefined | string; requiredMembers?: string[]; requiredZoneNames?: string[] }

A private link resource.

PrivateLinksGetResponse

PrivateLinksGetResponse: PrivateLinkResource

Contains response data for the get operation.

PrivateLinksListResponse

PrivateLinksListResponse: PrivateLinkResourceListResult

Contains response data for the list operation.

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

Creating
Deleting
Updating
Succeeded
Failed
Canceled

PublicNetworkAccess

PublicNetworkAccess: string

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

SystemAssignedServiceIdentityType

SystemAssignedServiceIdentityType: string

Defines values for SystemAssignedServiceIdentityType.
KnownSystemAssignedServiceIdentityType can be used interchangeably with SystemAssignedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned

TrackedResource

TrackedResource: Resource & { location: string; tags?: undefined | {} }

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

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 App

App: object

type

type: object

className

className: string = "App"

name

name: string = "Composite"

modelProperties

modelProperties: object

applicationId

applicationId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.applicationId"

type

type: object

name

name: string = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: string = "String"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "SystemAssignedServiceIdentity"

name

name: string = "Composite"

networkRuleSets

networkRuleSets: object

serializedName

serializedName: string = "properties.networkRuleSets"

type

type: object

className

className: string = "NetworkRuleSets"

name

name: string = "Composite"

privateEndpointConnections

privateEndpointConnections: object

readOnly

readOnly: 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

serializedName

serializedName: string = "properties.publicNetworkAccess"

type

type: object

name

name: string = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "AppSkuInfo"

name

name: string = "Composite"

state

state: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: string = "String"

subdomain

subdomain: object

serializedName

serializedName: string = "properties.subdomain"

type

type: object

name

name: string = "String"

template

template: object

serializedName

serializedName: string = "properties.template"

type

type: object

name

name: string = "String"

Const AppAvailabilityInfo

AppAvailabilityInfo: object

type

type: object

className

className: string = "AppAvailabilityInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

nameAvailable

nameAvailable: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nameAvailable"

type

type: object

name

name: string = "Boolean"

reason

reason: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "reason"

type

type: object

name

name: string = "String"

Const AppListResult

AppListResult: object

type

type: object

className

className: string = "AppListResult"

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 = "App"

name

name: string = "Composite"

Const AppPatch

AppPatch: object

type

type: object

className

className: string = "AppPatch"

name

name: string = "Composite"

modelProperties

modelProperties: object

applicationId

applicationId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.applicationId"

type

type: object

name

name: string = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: string = "String"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "SystemAssignedServiceIdentity"

name

name: string = "Composite"

networkRuleSets

networkRuleSets: object

serializedName

serializedName: string = "properties.networkRuleSets"

type

type: object

className

className: string = "NetworkRuleSets"

name

name: string = "Composite"

privateEndpointConnections

privateEndpointConnections: object

readOnly

readOnly: 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

serializedName

serializedName: string = "properties.publicNetworkAccess"

type

type: object

name

name: string = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "AppSkuInfo"

name

name: string = "Composite"

state

state: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: string = "String"

subdomain

subdomain: object

serializedName

serializedName: string = "properties.subdomain"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

template

template: object

serializedName

serializedName: string = "properties.template"

type

type: object

name

name: string = "String"

Const AppSkuInfo

AppSkuInfo: object

type

type: object

className

className: string = "AppSkuInfo"

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"

Const AppTemplate

AppTemplate: object

type

type: object

className

className: string = "AppTemplate"

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"

industry

industry: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "industry"

type

type: object

name

name: string = "String"

locations

locations: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "locations"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AppTemplateLocations"

name

name: string = "Composite"

manifestId

manifestId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifestId"

type

type: object

name

name: string = "String"

manifestVersion

manifestVersion: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "manifestVersion"

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"

order

order: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "order"

type

type: object

name

name: string = "Number"

title

title: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "title"

type

type: object

name

name: string = "String"

Const AppTemplateLocations

AppTemplateLocations: object

type

type: object

className

className: string = "AppTemplateLocations"

name

name: string = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const AppTemplatesResult

AppTemplatesResult: object

type

type: object

className

className: string = "AppTemplatesResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

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 = "AppTemplate"

name

name: string = "Composite"

Const AppsCreateOrUpdateHeaders

AppsCreateOrUpdateHeaders: object

type

type: object

className

className: string = "AppsCreateOrUpdateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

azureAsyncOperation

azureAsyncOperation: object

serializedName

serializedName: string = "azure-asyncoperation"

type

type: object

name

name: string = "String"

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "String"

Const AppsDeleteHeaders

AppsDeleteHeaders: object

type

type: object

className

className: string = "AppsDeleteHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

azureAsyncOperation

azureAsyncOperation: object

serializedName

serializedName: string = "azure-asyncoperation"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "String"

Const AppsUpdateHeaders

AppsUpdateHeaders: object

type

type: object

className

className: string = "AppsUpdateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

azureAsyncOperation

azureAsyncOperation: object

serializedName

serializedName: string = "azure-asyncoperation"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

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 NetworkRuleSetIpRule

NetworkRuleSetIpRule: object

type

type: object

className

className: string = "NetworkRuleSetIpRule"

name

name: string = "Composite"

modelProperties

modelProperties: object

filterName

filterName: object

serializedName

serializedName: string = "filterName"

type

type: object

name

name: string = "String"

ipMask

ipMask: object

serializedName

serializedName: string = "ipMask"

type

type: object

name

name: string = "String"

Const NetworkRuleSets

NetworkRuleSets: object

type

type: object

className

className: string = "NetworkRuleSets"

name

name: string = "Composite"

modelProperties

modelProperties: object

applyToDevices

applyToDevices: object

serializedName

serializedName: string = "applyToDevices"

type

type: object

name

name: string = "Boolean"

applyToIoTCentral

applyToIoTCentral: object

serializedName

serializedName: string = "applyToIoTCentral"

type

type: object

name

name: string = "Boolean"

defaultAction

defaultAction: object

serializedName

serializedName: string = "defaultAction"

type

type: object

name

name: string = "String"

ipRules

ipRules: object

serializedName

serializedName: string = "ipRules"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkRuleSetIpRule"

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"

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"

properties

properties: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties"

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 OperationInputs

OperationInputs: object

type

type: object

className

className: string = "OperationInputs"

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 = "IoTApps"

serializedName

serializedName: string = "type"

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

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

groupIds

groupIds: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.groupIds"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

privateEndpoint

privateEndpoint: object

serializedName

serializedName: string = "properties.privateEndpoint"

type

type: object

className

className: string = "PrivateEndpoint"

name

name: string = "Composite"

privateLinkServiceConnectionState

privateLinkServiceConnectionState: object

serializedName

serializedName: string = "properties.privateLinkServiceConnectionState"

type

type: object

className

className: string = "PrivateLinkServiceConnectionState"

name

name: string = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: string = "String"

Const PrivateEndpointConnectionListResult

PrivateEndpointConnectionListResult: object

type

type: object

className

className: string = "PrivateEndpointConnectionListResult"

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 PrivateEndpointConnectionsCreateHeaders

PrivateEndpointConnectionsCreateHeaders: object

type

type: object

className

className: string = "PrivateEndpointConnectionsCreateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

azureAsyncOperation

azureAsyncOperation: object

serializedName

serializedName: string = "azure-asyncoperation"

type

type: object

name

name: string = "String"

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "String"

Const PrivateEndpointConnectionsDeleteHeaders

PrivateEndpointConnectionsDeleteHeaders: object

type

type: object

className

className: string = "PrivateEndpointConnectionsDeleteHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

azureAsyncOperation

azureAsyncOperation: object

serializedName

serializedName: string = "azure-asyncoperation"

type

type: object

name

name: string = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "String"

Const PrivateLinkResource

PrivateLinkResource: object

type

type: object

className

className: string = "PrivateLinkResource"

name

name: string = "Composite"

modelProperties

modelProperties: object

groupId

groupId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.groupId"

type

type: object

name

name: string = "String"

requiredMembers

requiredMembers: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.requiredMembers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

requiredZoneNames

requiredZoneNames: object

serializedName

serializedName: string = "properties.requiredZoneNames"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const PrivateLinkResourceListResult

PrivateLinkResourceListResult: object

type

type: object

className

className: string = "PrivateLinkResourceListResult"

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 = "PrivateLinkResource"

name

name: string = "Composite"

Const PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState: object

type

type: object

className

className: string = "PrivateLinkServiceConnectionState"

name

name: string = "Composite"

modelProperties

modelProperties: object

actionsRequired

actionsRequired: object

serializedName

serializedName: string = "actionsRequired"

type

type: object

name

name: string = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

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 SystemAssignedServiceIdentity

SystemAssignedServiceIdentity: object

type

type: object

className

className: string = "SystemAssignedServiceIdentity"

name

name: string = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: string = "Uuid"

tenantId

tenantId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: string = "Uuid"

type

type: object

required

required: 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 TrackedResource

TrackedResource: object

type

type: object

className

className: string = "TrackedResource"

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"

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 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-11-01-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const app

app: object

mapper

mapper: any = AppMapper

parameterPath

parameterPath: string = "app"

Const appPatch

appPatch: object

mapper

mapper: any = AppPatchMapper

parameterPath

parameterPath: string = "appPatch"

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.IoTCentral/checkNameAvailability"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.operationInputs

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AppAvailabilityInfo

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const checkSubdomainAvailabilityOperationSpec

checkSubdomainAvailabilityOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.operationInputs

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AppAvailabilityInfo

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.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.privateEndpointConnection

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PrivateEndpointConnection

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsCreateHeaders

201

201: object

bodyMapper

bodyMapper: any = Mappers.PrivateEndpointConnection

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsCreateHeaders

202

202: object

bodyMapper

bodyMapper: any = Mappers.PrivateEndpointConnection

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsCreateHeaders

204

204: object

bodyMapper

bodyMapper: any = Mappers.PrivateEndpointConnection

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsCreateHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

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.IoTCentral/iotApps/{resourceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.app

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.App

headersMapper

headersMapper: any = Mappers.AppsCreateOrUpdateHeaders

201

201: object

bodyMapper

bodyMapper: any = Mappers.App

headersMapper

headersMapper: any = Mappers.AppsCreateOrUpdateHeaders

202

202: object

bodyMapper

bodyMapper: any = Mappers.App

headersMapper

headersMapper: any = Mappers.AppsCreateOrUpdateHeaders

204

204: object

bodyMapper

bodyMapper: any = Mappers.App

headersMapper

headersMapper: any = Mappers.AppsCreateOrUpdateHeaders

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.IoTCentral/iotApps/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsDeleteHeaders

201

201: object

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsDeleteHeaders

202

202: object

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsDeleteHeaders

204

204: object

headersMapper

headersMapper: any = Mappers.PrivateEndpointConnectionsDeleteHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getOperationSpec

getOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}/privateLinkResources/{groupId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.PrivateLinkResource

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const groupId

groupId: object

parameterPath

parameterPath: string = "groupId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "groupId"

type

type: object

name

name: string = "String"

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.AppListResult

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.IoTCentral/iotApps"

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.AppListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

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

200

200: object

bodyMapper

bodyMapper: any = Mappers.AppListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listBySubscriptionOperationSpec

listBySubscriptionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/iotApps"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AppListResult

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.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.OperationListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listOperationSpec

listOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/providers/Microsoft.IoTCentral/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 listTemplatesNextOperationSpec

listTemplatesNextOperationSpec: 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

200

200: object

bodyMapper

bodyMapper: any = Mappers.AppTemplatesResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listTemplatesOperationSpec

listTemplatesOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "POST"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/appTemplates"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AppTemplatesResult

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 operationInputs

operationInputs: object

mapper

mapper: any = OperationInputsMapper

parameterPath

parameterPath: string = "operationInputs"

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"

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"

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.IoTCentral/iotApps/{resourceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.appPatch

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

headersMapper

headersMapper: any = Mappers.AppsUpdateHeaders

201

201: object

headersMapper

headersMapper: any = Mappers.AppsUpdateHeaders

202

202: object

headersMapper

headersMapper: any = Mappers.AppsUpdateHeaders

204

204: object

headersMapper

headersMapper: any = Mappers.AppsUpdateHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Generated using TypeDoc