Register Device

PUT 
/devices/register

Register Device

Request

application/json

Body

deviceId stringnullable
connectionStringType stringnullable

Possible values: [SharedAccessSignature, SharedAccessKey, AuthorizationHeader]

Allowed values: SharedAccessSignature, SharedAccessKey, AuthorizationHeader

connectionStringLifetimeMinutes int32nullable

text/json

Body

deviceId stringnullable
connectionStringType stringnullable

Possible values: [SharedAccessSignature, SharedAccessKey, AuthorizationHeader]

Allowed values: SharedAccessSignature, SharedAccessKey, AuthorizationHeader

connectionStringLifetimeMinutes int32nullable

application/*+json

Body

deviceId stringnullable
connectionStringType stringnullable

Possible values: [SharedAccessSignature, SharedAccessKey, AuthorizationHeader]

Allowed values: SharedAccessSignature, SharedAccessKey, AuthorizationHeader

connectionStringLifetimeMinutes int32nullable

Responses

200

Registration credentials.

application/json

Schema

Schema

deviceId string
deviceUniqueId stringdeprecated
connectionString string
iotHubHostName string
iotHubDeviceId string
connectionStringType string
connectionStringExpiration date-timenullable
tokenRemainingLifetime [d.]hh:mm:ss[.fffffff]nullable

Example (from schema)

{
  "deviceId": "string",
  "connectionString": "string",
  "iotHubHostName": "string",
  "iotHubDeviceId": "string",
  "connectionStringType": "string",
  "connectionStringExpiration": "2024-05-16T12:58:21.672Z",
  "tokenRemainingLifetime": "1.12:34:00"
}

example-1

{
  "deviceId": "robot-1",
  "connectionString": "HostName=example.azure-devices.net;DeviceId=4158197e-b396-4151-a394-f2f29a59f5ab:robot-1;SharedAccessSignature=SharedAccessSignature sr=example.azure-devices.net%2fdevices%2f4158197e-b396-4151-a394-f2f29a59f5ab%3arobot-1&sig=GZaiZfvLu5gewVEiHGJzMVh9R9mwwgZxq3Kuagmsz0H6w%3d&se=1683277865",
  "connectionStringType": "SharedAccessSignature",
  "iotHubHostName": "example.azure-devices.net",
  "iotHubDeviceId": "4158197e-b396-4151-a394-f2f29a59f5ab:robot-1",
  "tokenRemainingLifetime": "160.23:59:59",
  "connectionStringExpiration": "2020-11-02T17:48:00+02:00"
}

400

Invalid request.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

423

Workspace disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...