-
Notifications
You must be signed in to change notification settings - Fork 234
/
azure.mgmt.iothub.v2017_07_01.models.IotHubProperties.yml
183 lines (155 loc) · 7.2 KB
/
azure.mgmt.iothub.v2017_07_01.models.IotHubProperties.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
### YamlMime:PythonClass
uid: azure.mgmt.iothub.v2017_07_01.models.IotHubProperties
name: IotHubProperties
fullName: azure.mgmt.iothub.v2017_07_01.models.IotHubProperties
module: azure.mgmt.iothub.v2017_07_01.models
inheritances:
- azure.mgmt.iothub._serialization.Model
summary: 'The properties of an IoT hub.
Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
syntax: 'IotHubProperties(*, authorization_policies: List[_models.SharedAccessSignatureAuthorizationRule]
| None = None, ip_filter_rules: List[_models.IpFilterRule] | None = None, event_hub_endpoints:
Dict[str, _models.EventHubProperties] | None = None, routing: _models.RoutingProperties
| None = None, storage_endpoints: Dict[str, _models.StorageEndpointProperties]
| None = None, messaging_endpoints: Dict[str, _models.MessagingEndpointProperties]
| None = None, enable_file_upload_notifications: bool | None = None, cloud_to_device:
_models.CloudToDeviceProperties | None = None, comments: str | None = None, operations_monitoring_properties:
_models.OperationsMonitoringProperties | None = None, features: str | _models.Capabilities
| None = None, **kwargs: Any)'
keywordOnlyParameters:
- name: authorization_policies
description: 'The shared access policies you can use to secure a connection
to the IoT hub.'
types:
- <xref:list>[<xref:azure.mgmt.iothub.v2017_07_01.models.SharedAccessSignatureAuthorizationRule>]
- name: ip_filter_rules
description: The IP filter rules.
types:
- <xref:list>[<xref:azure.mgmt.iothub.v2017_07_01.models.IpFilterRule>]
- name: event_hub_endpoints
description: 'The Event Hub-compatible endpoint properties. The possible keys
to this dictionary are events and operationsMonitoringEvents. Both of these
keys have to be
present in the dictionary while making create or update calls for the IoT hub.'
types:
- <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2017_07_01.models.EventHubProperties>]
- name: routing
description: 'The routing related properties of the IoT hub. See:
[https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging).'
types:
- <xref:azure.mgmt.iothub.v2017_07_01.models.RoutingProperties>
- name: storage_endpoints
description: 'The list of Azure Storage endpoints where you can upload files.
Currently you can configure only one Azure Storage account and that MUST have
its key as
$default. Specifying more than one storage account causes an error to be thrown.
Not specifying
a value for this property when the enableFileUploadNotifications property is
set to True,
causes an error to be thrown.'
types:
- <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2017_07_01.models.StorageEndpointProperties>]
- name: messaging_endpoints
description: 'The messaging endpoint properties for the file upload
notification queue.'
types:
- <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2017_07_01.models.MessagingEndpointProperties>]
- name: enable_file_upload_notifications
description: If True, file upload notifications are enabled.
types:
- <xref:bool>
- name: cloud_to_device
description: The IoT hub cloud-to-device messaging properties.
types:
- <xref:azure.mgmt.iothub.v2017_07_01.models.CloudToDeviceProperties>
- name: comments
description: IoT hub comments.
types:
- <xref:str>
- name: operations_monitoring_properties
description: 'The operations monitoring properties for the IoT
hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands,
DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations,
TwinQueries, JobsOperations, DirectMethods.'
types:
- <xref:azure.mgmt.iothub.v2017_07_01.models.OperationsMonitoringProperties>
- name: features
description: 'The capabilities and features enabled for the IoT hub. Known values
are:
"None" and "DeviceManagement".'
types:
- <xref:str>
- <xref:azure.mgmt.iothub.v2017_07_01.models.Capabilities>
variables:
- description: 'The shared access policies you can use to secure a connection to
the IoT hub.'
name: authorization_policies
types:
- <xref:list>[<xref:azure.mgmt.iothub.v2017_07_01.models.SharedAccessSignatureAuthorizationRule>]
- description: The IP filter rules.
name: ip_filter_rules
types:
- <xref:list>[<xref:azure.mgmt.iothub.v2017_07_01.models.IpFilterRule>]
- description: The provisioning state.
name: provisioning_state
types:
- <xref:str>
- description: The name of the host.
name: host_name
types:
- <xref:str>
- description: 'The Event Hub-compatible endpoint properties. The possible keys to
this dictionary are events and operationsMonitoringEvents. Both of these keys
have to be
present in the dictionary while making create or update calls for the IoT hub.'
name: event_hub_endpoints
types:
- <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2017_07_01.models.EventHubProperties>]
- description: 'The routing related properties of the IoT hub. See:
[https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging).'
name: routing
types:
- <xref:azure.mgmt.iothub.v2017_07_01.models.RoutingProperties>
- description: 'The list of Azure Storage endpoints where you can upload files.
Currently you can configure only one Azure Storage account and that MUST have
its key as
$default. Specifying more than one storage account causes an error to be thrown.
Not specifying
a value for this property when the enableFileUploadNotifications property is set
to True,
causes an error to be thrown.'
name: storage_endpoints
types:
- <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2017_07_01.models.StorageEndpointProperties>]
- description: 'The messaging endpoint properties for the file upload notification
queue.'
name: messaging_endpoints
types:
- <xref:dict>[<xref:str>, <xref:azure.mgmt.iothub.v2017_07_01.models.MessagingEndpointProperties>]
- description: If True, file upload notifications are enabled.
name: enable_file_upload_notifications
types:
- <xref:bool>
- description: The IoT hub cloud-to-device messaging properties.
name: cloud_to_device
types:
- <xref:azure.mgmt.iothub.v2017_07_01.models.CloudToDeviceProperties>
- description: IoT hub comments.
name: comments
types:
- <xref:str>
- description: 'The operations monitoring properties for the IoT hub.
The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands,
DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations,
TwinQueries, JobsOperations, DirectMethods.'
name: operations_monitoring_properties
types:
- <xref:azure.mgmt.iothub.v2017_07_01.models.OperationsMonitoringProperties>
- description: 'The capabilities and features enabled for the IoT hub. Known values
are: "None"
and "DeviceManagement".'
name: features
types:
- <xref:str>
- <xref:azure.mgmt.iothub.v2017_07_01.models.Capabilities>