-
Notifications
You must be signed in to change notification settings - Fork 254
/
EventHubProperties.xml
225 lines (225 loc) · 12.8 KB
/
EventHubProperties.xml
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<Type Name="EventHubProperties" FullName="Microsoft.Azure.Management.IotHub.Models.EventHubProperties">
<TypeSignature Language="C#" Value="public class EventHubProperties" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EventHubProperties extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.IotHub.Models.EventHubProperties" />
<TypeSignature Language="VB.NET" Value="Public Class EventHubProperties" />
<TypeSignature Language="F#" Value="type EventHubProperties = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The properties of the provisioned Event Hub-compatible endpoint used by
the IoT hub.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventHubProperties ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.EventHubProperties.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the EventHubProperties class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventHubProperties (long? retentionTimeInDays = default, int? partitionCount = default, System.Collections.Generic.IList<string> partitionIds = default, string path = default, string endpoint = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<int64> retentionTimeInDays, valuetype System.Nullable`1<int32> partitionCount, class System.Collections.Generic.IList`1<string> partitionIds, string path, string endpoint) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.IotHub.Models.EventHubProperties.#ctor(System.Nullable{System.Int64},System.Nullable{System.Int32},System.Collections.Generic.IList{System.String},System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional retentionTimeInDays As Nullable(Of Long) = Nothing, Optional partitionCount As Nullable(Of Integer) = Nothing, Optional partitionIds As IList(Of String) = Nothing, Optional path As String = Nothing, Optional endpoint As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.IotHub.Models.EventHubProperties : Nullable<int64> * Nullable<int> * System.Collections.Generic.IList<string> * string * string -> Microsoft.Azure.Management.IotHub.Models.EventHubProperties" Usage="new Microsoft.Azure.Management.IotHub.Models.EventHubProperties (retentionTimeInDays, partitionCount, partitionIds, path, endpoint)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="retentionTimeInDays" Type="System.Nullable<System.Int64>" />
<Parameter Name="partitionCount" Type="System.Nullable<System.Int32>" />
<Parameter Name="partitionIds" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="endpoint" Type="System.String" />
</Parameters>
<Docs>
<param name="retentionTimeInDays">The retention time for
device-to-cloud messages in days. See:
https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages</param>
<param name="partitionCount">The number of partitions for receiving
device-to-cloud messages in the Event Hub-compatible endpoint. See:
https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.</param>
<param name="partitionIds">The partition ids in the Event
Hub-compatible endpoint.</param>
<param name="path">The Event Hub-compatible name.</param>
<param name="endpoint">The Event Hub-compatible endpoint.</param>
<summary>
Initializes a new instance of the EventHubProperties class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Endpoint">
<MemberSignature Language="C#" Value="public string Endpoint { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Endpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EventHubProperties.Endpoint" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Endpoint As String" />
<MemberSignature Language="F#" Value="member this.Endpoint : string" Usage="Microsoft.Azure.Management.IotHub.Models.EventHubProperties.Endpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="endpoint")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="endpoint")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Event Hub-compatible endpoint.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PartitionCount">
<MemberSignature Language="C#" Value="public int? PartitionCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> PartitionCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EventHubProperties.PartitionCount" />
<MemberSignature Language="VB.NET" Value="Public Property PartitionCount As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.PartitionCount : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EventHubProperties.PartitionCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="partitionCount")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="partitionCount")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the number of partitions for receiving device-to-cloud
messages in the Event Hub-compatible endpoint. See:
https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PartitionIds">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> PartitionIds { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> PartitionIds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EventHubProperties.PartitionIds" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PartitionIds As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.PartitionIds : System.Collections.Generic.IList<string>" Usage="Microsoft.Azure.Management.IotHub.Models.EventHubProperties.PartitionIds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="partitionIds")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="partitionIds")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the partition ids in the Event Hub-compatible endpoint.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EventHubProperties.Path" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Path As String" />
<MemberSignature Language="F#" Value="member this.Path : string" Usage="Microsoft.Azure.Management.IotHub.Models.EventHubProperties.Path" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="path")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="path")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Event Hub-compatible name.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RetentionTimeInDays">
<MemberSignature Language="C#" Value="public long? RetentionTimeInDays { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> RetentionTimeInDays" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.IotHub.Models.EventHubProperties.RetentionTimeInDays" />
<MemberSignature Language="VB.NET" Value="Public Property RetentionTimeInDays As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.RetentionTimeInDays : Nullable<int64> with get, set" Usage="Microsoft.Azure.Management.IotHub.Models.EventHubProperties.RetentionTimeInDays" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.IotHub</AssemblyName>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="retentionTimeInDays")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="retentionTimeInDays")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the retention time for device-to-cloud messages in
days. See:
https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>