Client interface

The Client resource.

Extends

Properties

attributes

Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }

authenticationName

The name presented by the client for authentication. The default value is the name of the resource.

clientCertificateAuthentication

The client certificate authentication information.

description

Description for the Client resource.

provisioningState

Provisioning state of the Client resource. NOTE: This property will not be serialized. It can only be populated by the server.

state

Indicates if the client is enabled or not. Default value is Enabled.

systemData

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

Inherited Properties

id

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

name

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

type

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

Property Details

attributes

Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }

attributes?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

authenticationName

The name presented by the client for authentication. The default value is the name of the resource.

authenticationName?: string

Property Value

string

clientCertificateAuthentication

The client certificate authentication information.

clientCertificateAuthentication?: ClientCertificateAuthentication

Property Value

description

Description for the Client resource.

description?: string

Property Value

string

provisioningState

Provisioning state of the Client resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

state

Indicates if the client is enabled or not. Default value is Enabled.

state?: string

Property Value

string

systemData

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

systemData?: SystemData

Property Value

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From Resource.id

name

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

name?: string

Property Value

string

Inherited From Resource.name

type

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

type?: string

Property Value

string

Inherited From Resource.type