ClientProperties interface

The properties of client.

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.

state

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

Property Details

attributes

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

attributes?: Record<string, any>

Property Value

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

provisioningState?: string

Property Value

string

state

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

state?: string

Property Value

string