-
Notifications
You must be signed in to change notification settings - Fork 180
/
Client.TransportConfigOptions.yml
91 lines (90 loc) · 2.63 KB
/
Client.TransportConfigOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
### YamlMime:TSType
name: TransportConfigOptions
uid: azure-iothub.Client.TransportConfigOptions
package: azure-iothub
summary: ''
fullName: TransportConfigOptions
remarks: ''
isDeprecated: false
type: interface
properties:
- name: host
uid: azure-iothub.Client.TransportConfigOptions.host
package: azure-iothub
summary: Hostname of the Azure IoT hub. (<IoT hub name>.azure-devices.net).
fullName: host
remarks: ''
isDeprecated: false
syntax:
content: 'host: string'
return:
description: ''
type: string
- name: hubName
uid: azure-iothub.Client.TransportConfigOptions.hubName
package: azure-iothub
summary: ''
fullName: hubName
remarks: ''
isDeprecated: true
customDeprecatedMessage: >-
This is not used anywhere anymore.
Name of the Azure IoT hub. (The first section of the Azure IoT hub
hostname)
syntax:
content: 'hubName?: string'
return:
description: ''
type: string
- name: keyName
uid: azure-iothub.Client.TransportConfigOptions.keyName
package: azure-iothub
summary: The name of the policy used to connect to the Azure IoT Hub service.
fullName: keyName
remarks: ''
isDeprecated: false
syntax:
content: 'keyName?: string'
return:
description: ''
type: string
- name: sharedAccessSignature
uid: azure-iothub.Client.TransportConfigOptions.sharedAccessSignature
package: azure-iothub
summary: >-
The shared access signature token used to authenticate the connection with
the Azure IoT hub.
fullName: sharedAccessSignature
remarks: ''
isDeprecated: false
syntax:
content: 'sharedAccessSignature?: string | SharedAccessSignature'
return:
description: ''
type: string | SharedAccessSignature
- name: tokenCredential
uid: azure-iothub.Client.TransportConfigOptions.tokenCredential
package: azure-iothub
summary: >-
The token credential used to authenticate the connection with the Azure
IoT hub.
fullName: tokenCredential
remarks: ''
isDeprecated: false
syntax:
content: 'tokenCredential?: TokenCredential'
return:
description: ''
type: <xref uid="@azure/core-auth.TokenCredential" />
- name: tokenScope
uid: azure-iothub.Client.TransportConfigOptions.tokenScope
package: azure-iothub
summary: The token scope used to get the token from the TokenCredential object
fullName: tokenScope
remarks: ''
isDeprecated: false
syntax:
content: 'tokenScope?: string'
return:
description: ''
type: string