-
Notifications
You must be signed in to change notification settings - Fork 180
/
Eventhub.yml
230 lines (222 loc) · 6.79 KB
/
Eventhub.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
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
226
227
228
229
230
### YamlMime:TSType
name: Eventhub
uid: '@azure/arm-eventhub.Eventhub'
package: '@azure/arm-eventhub'
summary: Single item in List or Get Event Hub operation
fullName: Eventhub
remarks: ''
isDeprecated: false
type: interface
properties:
- name: captureDescription
uid: '@azure/arm-eventhub.Eventhub.captureDescription'
package: '@azure/arm-eventhub'
summary: Properties of capture description
fullName: captureDescription
remarks: ''
isDeprecated: false
syntax:
content: 'captureDescription?: CaptureDescription'
return:
description: ''
type: <xref uid="@azure/arm-eventhub.CaptureDescription" />
- name: createdAt
uid: '@azure/arm-eventhub.Eventhub.createdAt'
package: '@azure/arm-eventhub'
summary: >-
Exact time the Event Hub was created.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: createdAt
remarks: ''
isDeprecated: false
syntax:
content: 'createdAt?: Date'
return:
description: ''
type: Date
- name: messageRetentionInDays
uid: '@azure/arm-eventhub.Eventhub.messageRetentionInDays'
package: '@azure/arm-eventhub'
summary: >-
Number of days to retain the events for this Event Hub, value should be 1
to 7 days
fullName: messageRetentionInDays
remarks: ''
isDeprecated: false
syntax:
content: 'messageRetentionInDays?: number'
return:
description: ''
type: number
- name: partitionCount
uid: '@azure/arm-eventhub.Eventhub.partitionCount'
package: '@azure/arm-eventhub'
summary: >-
Number of partitions created for the Event Hub, allowed values are from 1
to 32 partitions.
fullName: partitionCount
remarks: ''
isDeprecated: false
syntax:
content: 'partitionCount?: number'
return:
description: ''
type: number
- name: partitionIds
uid: '@azure/arm-eventhub.Eventhub.partitionIds'
package: '@azure/arm-eventhub'
summary: >-
Current number of shards on the Event Hub.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: partitionIds
remarks: ''
isDeprecated: false
syntax:
content: 'partitionIds?: string[]'
return:
description: ''
type: string[]
- name: retentionDescription
uid: '@azure/arm-eventhub.Eventhub.retentionDescription'
package: '@azure/arm-eventhub'
summary: Event Hub retention settings
fullName: retentionDescription
remarks: ''
isDeprecated: false
syntax:
content: 'retentionDescription?: RetentionDescription'
return:
description: ''
type: <xref uid="@azure/arm-eventhub.RetentionDescription" />
- name: status
uid: '@azure/arm-eventhub.Eventhub.status'
package: '@azure/arm-eventhub'
summary: Enumerates the possible values for the status of the Event Hub.
fullName: status
remarks: ''
isDeprecated: false
syntax:
content: 'status?: EntityStatus'
return:
description: ''
type: <xref uid="@azure/arm-eventhub.EntityStatus" />
- name: systemData
uid: '@azure/arm-eventhub.Eventhub.systemData'
package: '@azure/arm-eventhub'
summary: >-
The system meta data relating to this resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: systemData
remarks: ''
isDeprecated: false
syntax:
content: 'systemData?: SystemData'
return:
description: ''
type: <xref uid="@azure/arm-eventhub.SystemData" />
- name: updatedAt
uid: '@azure/arm-eventhub.Eventhub.updatedAt'
package: '@azure/arm-eventhub'
summary: >-
The exact time the message was updated.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: updatedAt
remarks: ''
isDeprecated: false
syntax:
content: 'updatedAt?: Date'
return:
description: ''
type: Date
- name: userMetadata
uid: '@azure/arm-eventhub.Eventhub.userMetadata'
package: '@azure/arm-eventhub'
summary: Gets and Sets Metadata of User.
fullName: userMetadata
remarks: ''
isDeprecated: false
syntax:
content: 'userMetadata?: string'
return:
description: ''
type: string
inheritedProperties:
- name: id
uid: '@azure/arm-eventhub.Eventhub.id'
package: '@azure/arm-eventhub'
summary: >-
Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.id](xref:@azure/arm-eventhub.ProxyResource.id)
- name: location
uid: '@azure/arm-eventhub.Eventhub.location'
package: '@azure/arm-eventhub'
summary: >-
The geo-location where the resource lives
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: location
remarks: ''
isDeprecated: false
syntax:
content: 'location?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.location](xref:@azure/arm-eventhub.ProxyResource.location)
- name: name
uid: '@azure/arm-eventhub.Eventhub.name'
package: '@azure/arm-eventhub'
summary: >-
The name of the resource
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.name](xref:@azure/arm-eventhub.ProxyResource.name)
- name: type
uid: '@azure/arm-eventhub.Eventhub.type'
package: '@azure/arm-eventhub'
summary: >-
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or
"Microsoft.EventHub/Namespaces/EventHubs"
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.type](xref:@azure/arm-eventhub.ProxyResource.type)
extends: <xref uid="@azure/arm-eventhub.ProxyResource" />