Share via

AssetEndpointProfileProperties interface

  • Reference
Package:
@azure/arm-deviceregistry

Defines the Asset Endpoint Profile properties.

Properties

additionalConfiguration

Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
authentication

Defines the client authentication mechanism to the server.
discoveredAssetEndpointProfileRef

Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
endpointProfileType

Defines the configuration for the connector type that is being used with the endpoint profile.
provisioningState

Provisioning state of the resource.
status

Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
targetAddress

The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
uuid

Globally unique, immutable, non-reusable id.

Property Details

additionalConfiguration

Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).

additionalConfiguration?: string

Property Value

string

authentication

Defines the client authentication mechanism to the server.

authentication?: Authentication

Property Value

Authentication

discoveredAssetEndpointProfileRef

Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.

discoveredAssetEndpointProfileRef?: string

Property Value

string

endpointProfileType

Defines the configuration for the connector type that is being used with the endpoint profile.

endpointProfileType: string

Property Value

string

provisioningState

Provisioning state of the resource.

provisioningState?: string

Property Value

string

status

Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.

status?: AssetEndpointProfileStatus

Property Value

AssetEndpointProfileStatus

targetAddress

The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.

targetAddress: string

Property Value

string

uuid

Globally unique, immutable, non-reusable id.

uuid?: string

Property Value

string