IotHubDescription interface

Package:

@azure/arm-iothub

The description of the IoT hub.

Extends

Resource

Properties

etag	The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
identity	The managed identities for the IotHub.
properties	IotHub properties
sku	IotHub SKU info
systemData	The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.
location	The resource location.
name	The resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	The resource tags.
type	The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

etag

The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.

etag?: string

Property Value

string

identity

The managed identities for the IotHub.

identity?: ArmIdentity

Property Value

ArmIdentity

properties

IotHub properties

properties?: IotHubProperties

Property Value

IotHubProperties

sku

IotHub SKU info

sku: IotHubSkuInfo

Property Value

IotHubSkuInfo

systemData

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited Property Details

id

The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

The resource location.

location: string

Property Value

string

Inherited From Resource.location

name

The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

The resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type