@azure/arm-iothub-profile-2020-09-01-hybrid 2.1.1-alpha.20250619.1 → 2.1.1-alpha.20250717.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,1022 +1,1022 @@
1
- ## API Report File for "@azure/arm-iothub-profile-2020-09-01-hybrid"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import * as coreAuth from '@azure/core-auth';
8
- import * as coreClient from '@azure/core-client';
9
- import { PagedAsyncIterableIterator } from '@azure/core-paging';
10
- import { PollerLike } from '@azure/core-lro';
11
- import { PollOperationState } from '@azure/core-lro';
12
-
13
- // @public
14
- export type AccessRights = "RegistryRead" | "RegistryWrite" | "ServiceConnect" | "DeviceConnect" | "RegistryRead, RegistryWrite" | "RegistryRead, ServiceConnect" | "RegistryRead, DeviceConnect" | "RegistryWrite, ServiceConnect" | "RegistryWrite, DeviceConnect" | "ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect" | "RegistryRead, RegistryWrite, DeviceConnect" | "RegistryRead, ServiceConnect, DeviceConnect" | "RegistryWrite, ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect";
15
-
16
- // @public
17
- export type Capabilities = string;
18
-
19
- // @public
20
- export interface CertificateBodyDescription {
21
- certificate?: string;
22
- }
23
-
24
- // @public
25
- export interface CertificateDescription {
26
- readonly etag?: string;
27
- readonly id?: string;
28
- readonly name?: string;
29
- properties?: CertificateProperties;
30
- readonly type?: string;
31
- }
32
-
33
- // @public
34
- export interface CertificateListDescription {
35
- value?: CertificateDescription[];
36
- }
37
-
38
- // @public
39
- export interface CertificateProperties {
40
- certificate?: string;
41
- readonly created?: Date;
42
- readonly expiry?: Date;
43
- readonly isVerified?: boolean;
44
- readonly subject?: string;
45
- readonly thumbprint?: string;
46
- readonly updated?: Date;
47
- }
48
-
49
- // @public
50
- export interface CertificatePropertiesWithNonce {
51
- readonly certificate?: string;
52
- readonly created?: Date;
53
- readonly expiry?: Date;
54
- readonly isVerified?: boolean;
55
- readonly subject?: string;
56
- readonly thumbprint?: string;
57
- readonly updated?: Date;
58
- readonly verificationCode?: string;
59
- }
60
-
61
- // @public
62
- export interface Certificates {
63
- createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, certificateDescription: CertificateBodyDescription, options?: CertificatesCreateOrUpdateOptionalParams): Promise<CertificatesCreateOrUpdateResponse>;
64
- delete(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesDeleteOptionalParams): Promise<void>;
65
- generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesGenerateVerificationCodeOptionalParams): Promise<CertificatesGenerateVerificationCodeResponse>;
66
- get(resourceGroupName: string, resourceName: string, certificateName: string, options?: CertificatesGetOptionalParams): Promise<CertificatesGetResponse>;
67
- listByIotHub(resourceGroupName: string, resourceName: string, options?: CertificatesListByIotHubOptionalParams): Promise<CertificatesListByIotHubResponse>;
68
- verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, certificateVerificationBody: CertificateVerificationDescription, options?: CertificatesVerifyOptionalParams): Promise<CertificatesVerifyResponse>;
69
- }
70
-
71
- // @public
72
- export interface CertificatesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
73
- ifMatch?: string;
74
- }
75
-
76
- // @public
77
- export type CertificatesCreateOrUpdateResponse = CertificateDescription;
78
-
79
- // @public
80
- export interface CertificatesDeleteOptionalParams extends coreClient.OperationOptions {
81
- }
82
-
83
- // @public
84
- export interface CertificatesGenerateVerificationCodeOptionalParams extends coreClient.OperationOptions {
85
- }
86
-
87
- // @public
88
- export type CertificatesGenerateVerificationCodeResponse = CertificateWithNonceDescription;
89
-
90
- // @public
91
- export interface CertificatesGetOptionalParams extends coreClient.OperationOptions {
92
- }
93
-
94
- // @public
95
- export type CertificatesGetResponse = CertificateDescription;
96
-
97
- // @public
98
- export interface CertificatesListByIotHubOptionalParams extends coreClient.OperationOptions {
99
- }
100
-
101
- // @public
102
- export type CertificatesListByIotHubResponse = CertificateListDescription;
103
-
104
- // @public
105
- export interface CertificatesVerifyOptionalParams extends coreClient.OperationOptions {
106
- }
107
-
108
- // @public
109
- export type CertificatesVerifyResponse = CertificateDescription;
110
-
111
- // @public
112
- export interface CertificateVerificationDescription {
113
- certificate?: string;
114
- }
115
-
116
- // @public
117
- export interface CertificateWithNonceDescription {
118
- readonly etag?: string;
119
- readonly id?: string;
120
- readonly name?: string;
121
- properties?: CertificatePropertiesWithNonce;
122
- readonly type?: string;
123
- }
124
-
125
- // @public
126
- export interface CloudToDeviceProperties {
127
- defaultTtlAsIso8601?: string;
128
- feedback?: FeedbackProperties;
129
- maxDeliveryCount?: number;
130
- }
131
-
132
- // @public
133
- export interface EndpointHealthData {
134
- endpointId?: string;
135
- healthStatus?: EndpointHealthStatus;
136
- }
137
-
138
- // @public
139
- export interface EndpointHealthDataListResult {
140
- readonly nextLink?: string;
141
- value?: EndpointHealthData[];
142
- }
143
-
144
- // @public
145
- export type EndpointHealthStatus = string;
146
-
147
- // @public
148
- export interface EnrichmentProperties {
149
- endpointNames: string[];
150
- key: string;
151
- value: string;
152
- }
153
-
154
- // @public
155
- export interface ErrorDetails {
156
- readonly code?: string;
157
- readonly details?: string;
158
- readonly httpStatusCode?: string;
159
- readonly message?: string;
160
- }
161
-
162
- // @public
163
- export interface EventHubConsumerGroupInfo {
164
- readonly etag?: string;
165
- readonly id?: string;
166
- readonly name?: string;
167
- properties?: {
168
- [propertyName: string]: string;
169
- };
170
- readonly type?: string;
171
- }
172
-
173
- // @public
174
- export interface EventHubConsumerGroupsListResult {
175
- readonly nextLink?: string;
176
- value?: EventHubConsumerGroupInfo[];
177
- }
178
-
179
- // @public
180
- export interface EventHubProperties {
181
- readonly endpoint?: string;
182
- partitionCount?: number;
183
- readonly partitionIds?: string[];
184
- readonly path?: string;
185
- retentionTimeInDays?: number;
186
- }
187
-
188
- // @public
189
- export interface ExportDevicesRequest {
190
- excludeKeys: boolean;
191
- exportBlobContainerUri: string;
192
- }
193
-
194
- // @public
195
- export interface FailoverInput {
196
- failoverRegion: string;
197
- }
198
-
199
- // @public
200
- export interface FallbackRouteProperties {
201
- condition?: string;
202
- endpointNames: string[];
203
- isEnabled: boolean;
204
- name?: string;
205
- source: RoutingSource;
206
- }
207
-
208
- // @public
209
- export interface FeedbackProperties {
210
- lockDurationAsIso8601?: string;
211
- maxDeliveryCount?: number;
212
- ttlAsIso8601?: string;
213
- }
214
-
215
- // @public
216
- export function getContinuationToken(page: unknown): string | undefined;
217
-
218
- // @public
219
- export interface ImportDevicesRequest {
220
- inputBlobContainerUri: string;
221
- outputBlobContainerUri: string;
222
- }
223
-
224
- // @public
225
- export interface IotHub {
226
- beginManualFailover(iotHubName: string, resourceGroupName: string, failoverInput: FailoverInput, options?: IotHubManualFailoverOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
227
- beginManualFailoverAndWait(iotHubName: string, resourceGroupName: string, failoverInput: FailoverInput, options?: IotHubManualFailoverOptionalParams): Promise<void>;
228
- }
229
-
230
- // @public
231
- export interface IotHubCapacity {
232
- readonly default?: number;
233
- readonly maximum?: number;
234
- readonly minimum?: number;
235
- readonly scaleType?: IotHubScaleType;
236
- }
237
-
238
- // @public (undocumented)
239
- export class IotHubClient extends coreClient.ServiceClient {
240
- // (undocumented)
241
- $host: string;
242
- constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: IotHubClientOptionalParams);
243
- // (undocumented)
244
- apiVersion: string;
245
- // (undocumented)
246
- certificates: Certificates;
247
- // (undocumented)
248
- iotHub: IotHub;
249
- // (undocumented)
250
- iotHubResource: IotHubResource;
251
- // (undocumented)
252
- operations: Operations;
253
- // (undocumented)
254
- resourceProviderCommon: ResourceProviderCommon;
255
- // (undocumented)
256
- subscriptionId: string;
257
- }
258
-
259
- // @public
260
- export interface IotHubClientOptionalParams extends coreClient.ServiceClientOptions {
261
- $host?: string;
262
- apiVersion?: string;
263
- endpoint?: string;
264
- }
265
-
266
- // @public
267
- export interface IotHubDescription extends Resource {
268
- etag?: string;
269
- properties?: IotHubProperties;
270
- sku: IotHubSkuInfo;
271
- }
272
-
273
- // @public
274
- export interface IotHubDescriptionListResult {
275
- readonly nextLink?: string;
276
- value?: IotHubDescription[];
277
- }
278
-
279
- // @public
280
- export interface IotHubLocationDescription {
281
- location?: string;
282
- role?: IotHubReplicaRoleType;
283
- }
284
-
285
- // @public
286
- export interface IotHubManualFailoverOptionalParams extends coreClient.OperationOptions {
287
- resumeFrom?: string;
288
- updateIntervalInMs?: number;
289
- }
290
-
291
- // @public
292
- export interface IotHubNameAvailabilityInfo {
293
- message?: string;
294
- readonly nameAvailable?: boolean;
295
- readonly reason?: IotHubNameUnavailabilityReason;
296
- }
297
-
298
- // @public
299
- export type IotHubNameUnavailabilityReason = "Invalid" | "AlreadyExists";
300
-
301
- // @public
302
- export interface IotHubProperties {
303
- authorizationPolicies?: SharedAccessSignatureAuthorizationRule[];
304
- cloudToDevice?: CloudToDeviceProperties;
305
- comments?: string;
306
- deviceStreams?: IotHubPropertiesDeviceStreams;
307
- enableFileUploadNotifications?: boolean;
308
- eventHubEndpoints?: {
309
- [propertyName: string]: EventHubProperties;
310
- };
311
- features?: Capabilities;
312
- readonly hostName?: string;
313
- ipFilterRules?: IpFilterRule[];
314
- readonly locations?: IotHubLocationDescription[];
315
- messagingEndpoints?: {
316
- [propertyName: string]: MessagingEndpointProperties;
317
- };
318
- readonly provisioningState?: string;
319
- routing?: RoutingProperties;
320
- readonly state?: string;
321
- storageEndpoints?: {
322
- [propertyName: string]: StorageEndpointProperties;
323
- };
324
- }
325
-
326
- // @public
327
- export interface IotHubPropertiesDeviceStreams {
328
- streamingEndpoints?: string[];
329
- }
330
-
331
- // @public
332
- export interface IotHubQuotaMetricInfo {
333
- readonly currentValue?: number;
334
- readonly maxValue?: number;
335
- readonly name?: string;
336
- }
337
-
338
- // @public
339
- export interface IotHubQuotaMetricInfoListResult {
340
- readonly nextLink?: string;
341
- value?: IotHubQuotaMetricInfo[];
342
- }
343
-
344
- // @public
345
- export type IotHubReplicaRoleType = string;
346
-
347
- // @public
348
- export interface IotHubResource {
349
- beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubResourceCreateOrUpdateResponse>, IotHubResourceCreateOrUpdateResponse>>;
350
- beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubResourceCreateOrUpdateResponse>;
351
- beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<IotHubResourceDeleteResponse>, IotHubResourceDeleteResponse>>;
352
- beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubResourceDeleteResponse>;
353
- beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubResourceUpdateResponse>, IotHubResourceUpdateResponse>>;
354
- beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubResourceUpdateResponse>;
355
- checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubResourceCheckNameAvailabilityResponse>;
356
- createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<IotHubResourceCreateEventHubConsumerGroupResponse>;
357
- deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>;
358
- exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<IotHubResourceExportDevicesResponse>;
359
- get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubResourceGetResponse>;
360
- getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<IotHubResourceGetEventHubConsumerGroupResponse>;
361
- getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<IotHubResourceGetJobResponse>;
362
- getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<IotHubResourceGetKeysForKeyNameResponse>;
363
- getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<IotHubResourceGetStatsResponse>;
364
- importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<IotHubResourceImportDevicesResponse>;
365
- listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription>;
366
- listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription>;
367
- listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData>;
368
- listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo>;
369
- listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse>;
370
- listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule>;
371
- listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo>;
372
- listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription>;
373
- testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<IotHubResourceTestAllRoutesResponse>;
374
- testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<IotHubResourceTestRouteResponse>;
375
- }
376
-
377
- // @public
378
- export interface IotHubResourceCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
379
- }
380
-
381
- // @public
382
- export type IotHubResourceCheckNameAvailabilityResponse = IotHubNameAvailabilityInfo;
383
-
384
- // @public
385
- export interface IotHubResourceCreateEventHubConsumerGroupOptionalParams extends coreClient.OperationOptions {
386
- }
387
-
388
- // @public
389
- export type IotHubResourceCreateEventHubConsumerGroupResponse = EventHubConsumerGroupInfo;
390
-
391
- // @public
392
- export interface IotHubResourceCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
393
- ifMatch?: string;
394
- resumeFrom?: string;
395
- updateIntervalInMs?: number;
396
- }
397
-
398
- // @public
399
- export type IotHubResourceCreateOrUpdateResponse = IotHubDescription;
400
-
401
- // @public
402
- export interface IotHubResourceDeleteEventHubConsumerGroupOptionalParams extends coreClient.OperationOptions {
403
- }
404
-
405
- // @public
406
- export interface IotHubResourceDeleteOptionalParams extends coreClient.OperationOptions {
407
- resumeFrom?: string;
408
- updateIntervalInMs?: number;
409
- }
410
-
411
- // @public
412
- export type IotHubResourceDeleteResponse = IotHubDescription;
413
-
414
- // @public
415
- export interface IotHubResourceExportDevicesOptionalParams extends coreClient.OperationOptions {
416
- }
417
-
418
- // @public
419
- export type IotHubResourceExportDevicesResponse = JobResponse;
420
-
421
- // @public
422
- export interface IotHubResourceGetEndpointHealthNextOptionalParams extends coreClient.OperationOptions {
423
- }
424
-
425
- // @public
426
- export type IotHubResourceGetEndpointHealthNextResponse = EndpointHealthDataListResult;
427
-
428
- // @public
429
- export interface IotHubResourceGetEndpointHealthOptionalParams extends coreClient.OperationOptions {
430
- }
431
-
432
- // @public
433
- export type IotHubResourceGetEndpointHealthResponse = EndpointHealthDataListResult;
434
-
435
- // @public
436
- export interface IotHubResourceGetEventHubConsumerGroupOptionalParams extends coreClient.OperationOptions {
437
- }
438
-
439
- // @public
440
- export type IotHubResourceGetEventHubConsumerGroupResponse = EventHubConsumerGroupInfo;
441
-
442
- // @public
443
- export interface IotHubResourceGetJobOptionalParams extends coreClient.OperationOptions {
444
- }
445
-
446
- // @public
447
- export type IotHubResourceGetJobResponse = JobResponse;
448
-
449
- // @public
450
- export interface IotHubResourceGetKeysForKeyNameOptionalParams extends coreClient.OperationOptions {
451
- }
452
-
453
- // @public
454
- export type IotHubResourceGetKeysForKeyNameResponse = SharedAccessSignatureAuthorizationRule;
455
-
456
- // @public
457
- export interface IotHubResourceGetOptionalParams extends coreClient.OperationOptions {
458
- }
459
-
460
- // @public
461
- export interface IotHubResourceGetQuotaMetricsNextOptionalParams extends coreClient.OperationOptions {
462
- }
463
-
464
- // @public
465
- export type IotHubResourceGetQuotaMetricsNextResponse = IotHubQuotaMetricInfoListResult;
466
-
467
- // @public
468
- export interface IotHubResourceGetQuotaMetricsOptionalParams extends coreClient.OperationOptions {
469
- }
470
-
471
- // @public
472
- export type IotHubResourceGetQuotaMetricsResponse = IotHubQuotaMetricInfoListResult;
473
-
474
- // @public
475
- export type IotHubResourceGetResponse = IotHubDescription;
476
-
477
- // @public
478
- export interface IotHubResourceGetStatsOptionalParams extends coreClient.OperationOptions {
479
- }
480
-
481
- // @public
482
- export type IotHubResourceGetStatsResponse = RegistryStatistics;
483
-
484
- // @public
485
- export interface IotHubResourceGetValidSkusNextOptionalParams extends coreClient.OperationOptions {
486
- }
487
-
488
- // @public
489
- export type IotHubResourceGetValidSkusNextResponse = IotHubSkuDescriptionListResult;
490
-
491
- // @public
492
- export interface IotHubResourceGetValidSkusOptionalParams extends coreClient.OperationOptions {
493
- }
494
-
495
- // @public
496
- export type IotHubResourceGetValidSkusResponse = IotHubSkuDescriptionListResult;
497
-
498
- // @public
499
- export interface IotHubResourceImportDevicesOptionalParams extends coreClient.OperationOptions {
500
- }
501
-
502
- // @public
503
- export type IotHubResourceImportDevicesResponse = JobResponse;
504
-
505
- // @public
506
- export interface IotHubResourceListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
507
- }
508
-
509
- // @public
510
- export type IotHubResourceListByResourceGroupNextResponse = IotHubDescriptionListResult;
511
-
512
- // @public
513
- export interface IotHubResourceListByResourceGroupOptionalParams extends coreClient.OperationOptions {
514
- }
515
-
516
- // @public
517
- export type IotHubResourceListByResourceGroupResponse = IotHubDescriptionListResult;
518
-
519
- // @public
520
- export interface IotHubResourceListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
521
- }
522
-
523
- // @public
524
- export type IotHubResourceListBySubscriptionNextResponse = IotHubDescriptionListResult;
525
-
526
- // @public
527
- export interface IotHubResourceListBySubscriptionOptionalParams extends coreClient.OperationOptions {
528
- }
529
-
530
- // @public
531
- export type IotHubResourceListBySubscriptionResponse = IotHubDescriptionListResult;
532
-
533
- // @public
534
- export interface IotHubResourceListEventHubConsumerGroupsNextOptionalParams extends coreClient.OperationOptions {
535
- }
536
-
537
- // @public
538
- export type IotHubResourceListEventHubConsumerGroupsNextResponse = EventHubConsumerGroupsListResult;
539
-
540
- // @public
541
- export interface IotHubResourceListEventHubConsumerGroupsOptionalParams extends coreClient.OperationOptions {
542
- }
543
-
544
- // @public
545
- export type IotHubResourceListEventHubConsumerGroupsResponse = EventHubConsumerGroupsListResult;
546
-
547
- // @public
548
- export interface IotHubResourceListJobsNextOptionalParams extends coreClient.OperationOptions {
549
- }
550
-
551
- // @public
552
- export type IotHubResourceListJobsNextResponse = JobResponseListResult;
553
-
554
- // @public
555
- export interface IotHubResourceListJobsOptionalParams extends coreClient.OperationOptions {
556
- }
557
-
558
- // @public
559
- export type IotHubResourceListJobsResponse = JobResponseListResult;
560
-
561
- // @public
562
- export interface IotHubResourceListKeysNextOptionalParams extends coreClient.OperationOptions {
563
- }
564
-
565
- // @public
566
- export type IotHubResourceListKeysNextResponse = SharedAccessSignatureAuthorizationRuleListResult;
567
-
568
- // @public
569
- export interface IotHubResourceListKeysOptionalParams extends coreClient.OperationOptions {
570
- }
571
-
572
- // @public
573
- export type IotHubResourceListKeysResponse = SharedAccessSignatureAuthorizationRuleListResult;
574
-
575
- // @public
576
- export interface IotHubResourceTestAllRoutesOptionalParams extends coreClient.OperationOptions {
577
- }
578
-
579
- // @public
580
- export type IotHubResourceTestAllRoutesResponse = TestAllRoutesResult;
581
-
582
- // @public
583
- export interface IotHubResourceTestRouteOptionalParams extends coreClient.OperationOptions {
584
- }
585
-
586
- // @public
587
- export type IotHubResourceTestRouteResponse = TestRouteResult;
588
-
589
- // @public
590
- export interface IotHubResourceUpdateOptionalParams extends coreClient.OperationOptions {
591
- resumeFrom?: string;
592
- updateIntervalInMs?: number;
593
- }
594
-
595
- // @public
596
- export type IotHubResourceUpdateResponse = IotHubDescription;
597
-
598
- // @public
599
- export type IotHubScaleType = "Automatic" | "Manual" | "None";
600
-
601
- // @public
602
- export type IotHubSku = string;
603
-
604
- // @public
605
- export interface IotHubSkuDescription {
606
- capacity: IotHubCapacity;
607
- readonly resourceType?: string;
608
- sku: IotHubSkuInfo;
609
- }
610
-
611
- // @public
612
- export interface IotHubSkuDescriptionListResult {
613
- readonly nextLink?: string;
614
- value?: IotHubSkuDescription[];
615
- }
616
-
617
- // @public
618
- export interface IotHubSkuInfo {
619
- capacity?: number;
620
- name: IotHubSku;
621
- readonly tier?: IotHubSkuTier;
622
- }
623
-
624
- // @public
625
- export type IotHubSkuTier = "Free" | "Standard" | "Basic";
626
-
627
- // @public
628
- export type IpFilterActionType = "Accept" | "Reject";
629
-
630
- // @public
631
- export interface IpFilterRule {
632
- action: IpFilterActionType;
633
- filterName: string;
634
- ipMask: string;
635
- }
636
-
637
- // @public
638
- export interface JobResponse {
639
- readonly endTimeUtc?: Date;
640
- readonly failureReason?: string;
641
- readonly jobId?: string;
642
- readonly parentJobId?: string;
643
- readonly startTimeUtc?: Date;
644
- readonly status?: JobStatus;
645
- readonly statusMessage?: string;
646
- readonly type?: JobType;
647
- }
648
-
649
- // @public
650
- export interface JobResponseListResult {
651
- readonly nextLink?: string;
652
- value?: JobResponse[];
653
- }
654
-
655
- // @public
656
- export type JobStatus = "unknown" | "enqueued" | "running" | "completed" | "failed" | "cancelled";
657
-
658
- // @public
659
- export type JobType = string;
660
-
661
- // @public
662
- export enum KnownCapabilities {
663
- DeviceManagement = "DeviceManagement",
664
- None = "None"
665
- }
666
-
667
- // @public
668
- export enum KnownEndpointHealthStatus {
669
- Dead = "dead",
670
- Healthy = "healthy",
671
- Unhealthy = "unhealthy",
672
- Unknown = "unknown"
673
- }
674
-
675
- // @public
676
- export enum KnownIotHubReplicaRoleType {
677
- Primary = "primary",
678
- Secondary = "secondary"
679
- }
680
-
681
- // @public
682
- export enum KnownIotHubSku {
683
- B1 = "B1",
684
- B2 = "B2",
685
- B3 = "B3",
686
- F1 = "F1",
687
- S1 = "S1",
688
- S2 = "S2",
689
- S3 = "S3"
690
- }
691
-
692
- // @public
693
- export enum KnownJobType {
694
- Backup = "backup",
695
- Export = "export",
696
- FactoryResetDevice = "factoryResetDevice",
697
- FirmwareUpdate = "firmwareUpdate",
698
- Import = "import",
699
- ReadDeviceProperties = "readDeviceProperties",
700
- RebootDevice = "rebootDevice",
701
- Unknown = "unknown",
702
- UpdateDeviceConfiguration = "updateDeviceConfiguration",
703
- WriteDeviceProperties = "writeDeviceProperties"
704
- }
705
-
706
- // @public
707
- export enum KnownRouteErrorSeverity {
708
- Error = "error",
709
- Warning = "warning"
710
- }
711
-
712
- // @public
713
- export enum KnownRoutingSource {
714
- DeviceJobLifecycleEvents = "DeviceJobLifecycleEvents",
715
- DeviceLifecycleEvents = "DeviceLifecycleEvents",
716
- DeviceMessages = "DeviceMessages",
717
- DigitalTwinChangeEvents = "DigitalTwinChangeEvents",
718
- Invalid = "Invalid",
719
- TwinChangeEvents = "TwinChangeEvents"
720
- }
721
-
722
- // @public
723
- export enum KnownRoutingStorageContainerPropertiesEncoding {
724
- Avro = "Avro",
725
- AvroDeflate = "AvroDeflate",
726
- Json = "JSON"
727
- }
728
-
729
- // @public
730
- export enum KnownTestResultStatus {
731
- False = "false",
732
- True = "true",
733
- Undefined = "undefined"
734
- }
735
-
736
- // @public
737
- export interface MatchedRoute {
738
- properties?: RouteProperties;
739
- }
740
-
741
- // @public
742
- export interface MessagingEndpointProperties {
743
- lockDurationAsIso8601?: string;
744
- maxDeliveryCount?: number;
745
- ttlAsIso8601?: string;
746
- }
747
-
748
- // @public
749
- export interface Name {
750
- localizedValue?: string;
751
- value?: string;
752
- }
753
-
754
- // @public
755
- export interface Operation {
756
- display?: OperationDisplay;
757
- readonly name?: string;
758
- }
759
-
760
- // @public
761
- export interface OperationDisplay {
762
- readonly description?: string;
763
- readonly operation?: string;
764
- readonly provider?: string;
765
- readonly resource?: string;
766
- }
767
-
768
- // @public
769
- export interface OperationInputs {
770
- name: string;
771
- }
772
-
773
- // @public
774
- export interface OperationListResult {
775
- readonly nextLink?: string;
776
- readonly value?: Operation[];
777
- }
778
-
779
- // @public
780
- export interface Operations {
781
- list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
782
- }
783
-
784
- // @public
785
- export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
786
- }
787
-
788
- // @public
789
- export type OperationsListNextResponse = OperationListResult;
790
-
791
- // @public
792
- export interface OperationsListOptionalParams extends coreClient.OperationOptions {
793
- }
794
-
795
- // @public
796
- export type OperationsListResponse = OperationListResult;
797
-
798
- // @public
799
- export interface RegistryStatistics {
800
- readonly disabledDeviceCount?: number;
801
- readonly enabledDeviceCount?: number;
802
- readonly totalDeviceCount?: number;
803
- }
804
-
805
- // @public
806
- export interface Resource {
807
- readonly id?: string;
808
- location: string;
809
- readonly name?: string;
810
- tags?: {
811
- [propertyName: string]: string;
812
- };
813
- readonly type?: string;
814
- }
815
-
816
- // @public
817
- export interface ResourceProviderCommon {
818
- getSubscriptionQuota(options?: ResourceProviderCommonGetSubscriptionQuotaOptionalParams): Promise<ResourceProviderCommonGetSubscriptionQuotaResponse>;
819
- }
820
-
821
- // @public
822
- export interface ResourceProviderCommonGetSubscriptionQuotaOptionalParams extends coreClient.OperationOptions {
823
- }
824
-
825
- // @public
826
- export type ResourceProviderCommonGetSubscriptionQuotaResponse = UserSubscriptionQuotaListResult;
827
-
828
- // @public
829
- export interface RouteCompilationError {
830
- location?: RouteErrorRange;
831
- message?: string;
832
- severity?: RouteErrorSeverity;
833
- }
834
-
835
- // @public
836
- export interface RouteErrorPosition {
837
- column?: number;
838
- line?: number;
839
- }
840
-
841
- // @public
842
- export interface RouteErrorRange {
843
- end?: RouteErrorPosition;
844
- start?: RouteErrorPosition;
845
- }
846
-
847
- // @public
848
- export type RouteErrorSeverity = string;
849
-
850
- // @public
851
- export interface RouteProperties {
852
- condition?: string;
853
- endpointNames: string[];
854
- isEnabled: boolean;
855
- name: string;
856
- source: RoutingSource;
857
- }
858
-
859
- // @public
860
- export interface RoutingEndpoints {
861
- eventHubs?: RoutingEventHubProperties[];
862
- serviceBusQueues?: RoutingServiceBusQueueEndpointProperties[];
863
- serviceBusTopics?: RoutingServiceBusTopicEndpointProperties[];
864
- storageContainers?: RoutingStorageContainerProperties[];
865
- }
866
-
867
- // @public
868
- export interface RoutingEventHubProperties {
869
- connectionString: string;
870
- name: string;
871
- resourceGroup?: string;
872
- subscriptionId?: string;
873
- }
874
-
875
- // @public
876
- export interface RoutingMessage {
877
- appProperties?: {
878
- [propertyName: string]: string;
879
- };
880
- body?: string;
881
- systemProperties?: {
882
- [propertyName: string]: string;
883
- };
884
- }
885
-
886
- // @public
887
- export interface RoutingProperties {
888
- endpoints?: RoutingEndpoints;
889
- enrichments?: EnrichmentProperties[];
890
- fallbackRoute?: FallbackRouteProperties;
891
- routes?: RouteProperties[];
892
- }
893
-
894
- // @public
895
- export interface RoutingServiceBusQueueEndpointProperties {
896
- connectionString: string;
897
- name: string;
898
- resourceGroup?: string;
899
- subscriptionId?: string;
900
- }
901
-
902
- // @public
903
- export interface RoutingServiceBusTopicEndpointProperties {
904
- connectionString: string;
905
- name: string;
906
- resourceGroup?: string;
907
- subscriptionId?: string;
908
- }
909
-
910
- // @public
911
- export type RoutingSource = string;
912
-
913
- // @public
914
- export interface RoutingStorageContainerProperties {
915
- batchFrequencyInSeconds?: number;
916
- connectionString: string;
917
- containerName: string;
918
- encoding?: RoutingStorageContainerPropertiesEncoding;
919
- fileNameFormat?: string;
920
- maxChunkSizeInBytes?: number;
921
- name: string;
922
- resourceGroup?: string;
923
- subscriptionId?: string;
924
- }
925
-
926
- // @public
927
- export type RoutingStorageContainerPropertiesEncoding = string;
928
-
929
- // @public
930
- export interface RoutingTwin {
931
- // (undocumented)
932
- properties?: RoutingTwinProperties;
933
- tags?: Record<string, unknown>;
934
- }
935
-
936
- // @public (undocumented)
937
- export interface RoutingTwinProperties {
938
- desired?: Record<string, unknown>;
939
- reported?: Record<string, unknown>;
940
- }
941
-
942
- // @public
943
- export interface SharedAccessSignatureAuthorizationRule {
944
- keyName: string;
945
- primaryKey?: string;
946
- rights: AccessRights;
947
- secondaryKey?: string;
948
- }
949
-
950
- // @public
951
- export interface SharedAccessSignatureAuthorizationRuleListResult {
952
- readonly nextLink?: string;
953
- value?: SharedAccessSignatureAuthorizationRule[];
954
- }
955
-
956
- // @public
957
- export interface StorageEndpointProperties {
958
- connectionString: string;
959
- containerName: string;
960
- sasTtlAsIso8601?: string;
961
- }
962
-
963
- // @public
964
- export interface TagsResource {
965
- tags?: {
966
- [propertyName: string]: string;
967
- };
968
- }
969
-
970
- // @public
971
- export interface TestAllRoutesInput {
972
- message?: RoutingMessage;
973
- routingSource?: RoutingSource;
974
- twin?: RoutingTwin;
975
- }
976
-
977
- // @public
978
- export interface TestAllRoutesResult {
979
- routes?: MatchedRoute[];
980
- }
981
-
982
- // @public
983
- export type TestResultStatus = string;
984
-
985
- // @public
986
- export interface TestRouteInput {
987
- message?: RoutingMessage;
988
- route: RouteProperties;
989
- twin?: RoutingTwin;
990
- }
991
-
992
- // @public
993
- export interface TestRouteResult {
994
- details?: TestRouteResultDetails;
995
- result?: TestResultStatus;
996
- }
997
-
998
- // @public
999
- export interface TestRouteResultDetails {
1000
- compilationErrors?: RouteCompilationError[];
1001
- }
1002
-
1003
- // @public
1004
- export interface UserSubscriptionQuota {
1005
- currentValue?: number;
1006
- id?: string;
1007
- limit?: number;
1008
- name?: Name;
1009
- type?: string;
1010
- unit?: string;
1011
- }
1012
-
1013
- // @public
1014
- export interface UserSubscriptionQuotaListResult {
1015
- readonly nextLink?: string;
1016
- // (undocumented)
1017
- value?: UserSubscriptionQuota[];
1018
- }
1019
-
1020
- // (No @packageDocumentation comment for this package)
1021
-
1022
- ```
1
+ ## API Report File for "@azure/arm-iothub-profile-2020-09-01-hybrid"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import * as coreAuth from '@azure/core-auth';
8
+ import * as coreClient from '@azure/core-client';
9
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
10
+ import { PollerLike } from '@azure/core-lro';
11
+ import { PollOperationState } from '@azure/core-lro';
12
+
13
+ // @public
14
+ export type AccessRights = "RegistryRead" | "RegistryWrite" | "ServiceConnect" | "DeviceConnect" | "RegistryRead, RegistryWrite" | "RegistryRead, ServiceConnect" | "RegistryRead, DeviceConnect" | "RegistryWrite, ServiceConnect" | "RegistryWrite, DeviceConnect" | "ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect" | "RegistryRead, RegistryWrite, DeviceConnect" | "RegistryRead, ServiceConnect, DeviceConnect" | "RegistryWrite, ServiceConnect, DeviceConnect" | "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect";
15
+
16
+ // @public
17
+ export type Capabilities = string;
18
+
19
+ // @public
20
+ export interface CertificateBodyDescription {
21
+ certificate?: string;
22
+ }
23
+
24
+ // @public
25
+ export interface CertificateDescription {
26
+ readonly etag?: string;
27
+ readonly id?: string;
28
+ readonly name?: string;
29
+ properties?: CertificateProperties;
30
+ readonly type?: string;
31
+ }
32
+
33
+ // @public
34
+ export interface CertificateListDescription {
35
+ value?: CertificateDescription[];
36
+ }
37
+
38
+ // @public
39
+ export interface CertificateProperties {
40
+ certificate?: string;
41
+ readonly created?: Date;
42
+ readonly expiry?: Date;
43
+ readonly isVerified?: boolean;
44
+ readonly subject?: string;
45
+ readonly thumbprint?: string;
46
+ readonly updated?: Date;
47
+ }
48
+
49
+ // @public
50
+ export interface CertificatePropertiesWithNonce {
51
+ readonly certificate?: string;
52
+ readonly created?: Date;
53
+ readonly expiry?: Date;
54
+ readonly isVerified?: boolean;
55
+ readonly subject?: string;
56
+ readonly thumbprint?: string;
57
+ readonly updated?: Date;
58
+ readonly verificationCode?: string;
59
+ }
60
+
61
+ // @public
62
+ export interface Certificates {
63
+ createOrUpdate(resourceGroupName: string, resourceName: string, certificateName: string, certificateDescription: CertificateBodyDescription, options?: CertificatesCreateOrUpdateOptionalParams): Promise<CertificatesCreateOrUpdateResponse>;
64
+ delete(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesDeleteOptionalParams): Promise<void>;
65
+ generateVerificationCode(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, options?: CertificatesGenerateVerificationCodeOptionalParams): Promise<CertificatesGenerateVerificationCodeResponse>;
66
+ get(resourceGroupName: string, resourceName: string, certificateName: string, options?: CertificatesGetOptionalParams): Promise<CertificatesGetResponse>;
67
+ listByIotHub(resourceGroupName: string, resourceName: string, options?: CertificatesListByIotHubOptionalParams): Promise<CertificatesListByIotHubResponse>;
68
+ verify(resourceGroupName: string, resourceName: string, certificateName: string, ifMatch: string, certificateVerificationBody: CertificateVerificationDescription, options?: CertificatesVerifyOptionalParams): Promise<CertificatesVerifyResponse>;
69
+ }
70
+
71
+ // @public
72
+ export interface CertificatesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
73
+ ifMatch?: string;
74
+ }
75
+
76
+ // @public
77
+ export type CertificatesCreateOrUpdateResponse = CertificateDescription;
78
+
79
+ // @public
80
+ export interface CertificatesDeleteOptionalParams extends coreClient.OperationOptions {
81
+ }
82
+
83
+ // @public
84
+ export interface CertificatesGenerateVerificationCodeOptionalParams extends coreClient.OperationOptions {
85
+ }
86
+
87
+ // @public
88
+ export type CertificatesGenerateVerificationCodeResponse = CertificateWithNonceDescription;
89
+
90
+ // @public
91
+ export interface CertificatesGetOptionalParams extends coreClient.OperationOptions {
92
+ }
93
+
94
+ // @public
95
+ export type CertificatesGetResponse = CertificateDescription;
96
+
97
+ // @public
98
+ export interface CertificatesListByIotHubOptionalParams extends coreClient.OperationOptions {
99
+ }
100
+
101
+ // @public
102
+ export type CertificatesListByIotHubResponse = CertificateListDescription;
103
+
104
+ // @public
105
+ export interface CertificatesVerifyOptionalParams extends coreClient.OperationOptions {
106
+ }
107
+
108
+ // @public
109
+ export type CertificatesVerifyResponse = CertificateDescription;
110
+
111
+ // @public
112
+ export interface CertificateVerificationDescription {
113
+ certificate?: string;
114
+ }
115
+
116
+ // @public
117
+ export interface CertificateWithNonceDescription {
118
+ readonly etag?: string;
119
+ readonly id?: string;
120
+ readonly name?: string;
121
+ properties?: CertificatePropertiesWithNonce;
122
+ readonly type?: string;
123
+ }
124
+
125
+ // @public
126
+ export interface CloudToDeviceProperties {
127
+ defaultTtlAsIso8601?: string;
128
+ feedback?: FeedbackProperties;
129
+ maxDeliveryCount?: number;
130
+ }
131
+
132
+ // @public
133
+ export interface EndpointHealthData {
134
+ endpointId?: string;
135
+ healthStatus?: EndpointHealthStatus;
136
+ }
137
+
138
+ // @public
139
+ export interface EndpointHealthDataListResult {
140
+ readonly nextLink?: string;
141
+ value?: EndpointHealthData[];
142
+ }
143
+
144
+ // @public
145
+ export type EndpointHealthStatus = string;
146
+
147
+ // @public
148
+ export interface EnrichmentProperties {
149
+ endpointNames: string[];
150
+ key: string;
151
+ value: string;
152
+ }
153
+
154
+ // @public
155
+ export interface ErrorDetails {
156
+ readonly code?: string;
157
+ readonly details?: string;
158
+ readonly httpStatusCode?: string;
159
+ readonly message?: string;
160
+ }
161
+
162
+ // @public
163
+ export interface EventHubConsumerGroupInfo {
164
+ readonly etag?: string;
165
+ readonly id?: string;
166
+ readonly name?: string;
167
+ properties?: {
168
+ [propertyName: string]: string;
169
+ };
170
+ readonly type?: string;
171
+ }
172
+
173
+ // @public
174
+ export interface EventHubConsumerGroupsListResult {
175
+ readonly nextLink?: string;
176
+ value?: EventHubConsumerGroupInfo[];
177
+ }
178
+
179
+ // @public
180
+ export interface EventHubProperties {
181
+ readonly endpoint?: string;
182
+ partitionCount?: number;
183
+ readonly partitionIds?: string[];
184
+ readonly path?: string;
185
+ retentionTimeInDays?: number;
186
+ }
187
+
188
+ // @public
189
+ export interface ExportDevicesRequest {
190
+ excludeKeys: boolean;
191
+ exportBlobContainerUri: string;
192
+ }
193
+
194
+ // @public
195
+ export interface FailoverInput {
196
+ failoverRegion: string;
197
+ }
198
+
199
+ // @public
200
+ export interface FallbackRouteProperties {
201
+ condition?: string;
202
+ endpointNames: string[];
203
+ isEnabled: boolean;
204
+ name?: string;
205
+ source: RoutingSource;
206
+ }
207
+
208
+ // @public
209
+ export interface FeedbackProperties {
210
+ lockDurationAsIso8601?: string;
211
+ maxDeliveryCount?: number;
212
+ ttlAsIso8601?: string;
213
+ }
214
+
215
+ // @public
216
+ export function getContinuationToken(page: unknown): string | undefined;
217
+
218
+ // @public
219
+ export interface ImportDevicesRequest {
220
+ inputBlobContainerUri: string;
221
+ outputBlobContainerUri: string;
222
+ }
223
+
224
+ // @public
225
+ export interface IotHub {
226
+ beginManualFailover(iotHubName: string, resourceGroupName: string, failoverInput: FailoverInput, options?: IotHubManualFailoverOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
227
+ beginManualFailoverAndWait(iotHubName: string, resourceGroupName: string, failoverInput: FailoverInput, options?: IotHubManualFailoverOptionalParams): Promise<void>;
228
+ }
229
+
230
+ // @public
231
+ export interface IotHubCapacity {
232
+ readonly default?: number;
233
+ readonly maximum?: number;
234
+ readonly minimum?: number;
235
+ readonly scaleType?: IotHubScaleType;
236
+ }
237
+
238
+ // @public (undocumented)
239
+ export class IotHubClient extends coreClient.ServiceClient {
240
+ // (undocumented)
241
+ $host: string;
242
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: IotHubClientOptionalParams);
243
+ // (undocumented)
244
+ apiVersion: string;
245
+ // (undocumented)
246
+ certificates: Certificates;
247
+ // (undocumented)
248
+ iotHub: IotHub;
249
+ // (undocumented)
250
+ iotHubResource: IotHubResource;
251
+ // (undocumented)
252
+ operations: Operations;
253
+ // (undocumented)
254
+ resourceProviderCommon: ResourceProviderCommon;
255
+ // (undocumented)
256
+ subscriptionId: string;
257
+ }
258
+
259
+ // @public
260
+ export interface IotHubClientOptionalParams extends coreClient.ServiceClientOptions {
261
+ $host?: string;
262
+ apiVersion?: string;
263
+ endpoint?: string;
264
+ }
265
+
266
+ // @public
267
+ export interface IotHubDescription extends Resource {
268
+ etag?: string;
269
+ properties?: IotHubProperties;
270
+ sku: IotHubSkuInfo;
271
+ }
272
+
273
+ // @public
274
+ export interface IotHubDescriptionListResult {
275
+ readonly nextLink?: string;
276
+ value?: IotHubDescription[];
277
+ }
278
+
279
+ // @public
280
+ export interface IotHubLocationDescription {
281
+ location?: string;
282
+ role?: IotHubReplicaRoleType;
283
+ }
284
+
285
+ // @public
286
+ export interface IotHubManualFailoverOptionalParams extends coreClient.OperationOptions {
287
+ resumeFrom?: string;
288
+ updateIntervalInMs?: number;
289
+ }
290
+
291
+ // @public
292
+ export interface IotHubNameAvailabilityInfo {
293
+ message?: string;
294
+ readonly nameAvailable?: boolean;
295
+ readonly reason?: IotHubNameUnavailabilityReason;
296
+ }
297
+
298
+ // @public
299
+ export type IotHubNameUnavailabilityReason = "Invalid" | "AlreadyExists";
300
+
301
+ // @public
302
+ export interface IotHubProperties {
303
+ authorizationPolicies?: SharedAccessSignatureAuthorizationRule[];
304
+ cloudToDevice?: CloudToDeviceProperties;
305
+ comments?: string;
306
+ deviceStreams?: IotHubPropertiesDeviceStreams;
307
+ enableFileUploadNotifications?: boolean;
308
+ eventHubEndpoints?: {
309
+ [propertyName: string]: EventHubProperties;
310
+ };
311
+ features?: Capabilities;
312
+ readonly hostName?: string;
313
+ ipFilterRules?: IpFilterRule[];
314
+ readonly locations?: IotHubLocationDescription[];
315
+ messagingEndpoints?: {
316
+ [propertyName: string]: MessagingEndpointProperties;
317
+ };
318
+ readonly provisioningState?: string;
319
+ routing?: RoutingProperties;
320
+ readonly state?: string;
321
+ storageEndpoints?: {
322
+ [propertyName: string]: StorageEndpointProperties;
323
+ };
324
+ }
325
+
326
+ // @public
327
+ export interface IotHubPropertiesDeviceStreams {
328
+ streamingEndpoints?: string[];
329
+ }
330
+
331
+ // @public
332
+ export interface IotHubQuotaMetricInfo {
333
+ readonly currentValue?: number;
334
+ readonly maxValue?: number;
335
+ readonly name?: string;
336
+ }
337
+
338
+ // @public
339
+ export interface IotHubQuotaMetricInfoListResult {
340
+ readonly nextLink?: string;
341
+ value?: IotHubQuotaMetricInfo[];
342
+ }
343
+
344
+ // @public
345
+ export type IotHubReplicaRoleType = string;
346
+
347
+ // @public
348
+ export interface IotHubResource {
349
+ beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubResourceCreateOrUpdateResponse>, IotHubResourceCreateOrUpdateResponse>>;
350
+ beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: IotHubResourceCreateOrUpdateOptionalParams): Promise<IotHubResourceCreateOrUpdateResponse>;
351
+ beginDelete(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<IotHubResourceDeleteResponse>, IotHubResourceDeleteResponse>>;
352
+ beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: IotHubResourceDeleteOptionalParams): Promise<IotHubResourceDeleteResponse>;
353
+ beginUpdate(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<IotHubResourceUpdateResponse>, IotHubResourceUpdateResponse>>;
354
+ beginUpdateAndWait(resourceGroupName: string, resourceName: string, iotHubTags: TagsResource, options?: IotHubResourceUpdateOptionalParams): Promise<IotHubResourceUpdateResponse>;
355
+ checkNameAvailability(operationInputs: OperationInputs, options?: IotHubResourceCheckNameAvailabilityOptionalParams): Promise<IotHubResourceCheckNameAvailabilityResponse>;
356
+ createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceCreateEventHubConsumerGroupOptionalParams): Promise<IotHubResourceCreateEventHubConsumerGroupResponse>;
357
+ deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceDeleteEventHubConsumerGroupOptionalParams): Promise<void>;
358
+ exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: IotHubResourceExportDevicesOptionalParams): Promise<IotHubResourceExportDevicesResponse>;
359
+ get(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetOptionalParams): Promise<IotHubResourceGetResponse>;
360
+ getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: IotHubResourceGetEventHubConsumerGroupOptionalParams): Promise<IotHubResourceGetEventHubConsumerGroupResponse>;
361
+ getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: IotHubResourceGetJobOptionalParams): Promise<IotHubResourceGetJobResponse>;
362
+ getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: IotHubResourceGetKeysForKeyNameOptionalParams): Promise<IotHubResourceGetKeysForKeyNameResponse>;
363
+ getStats(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetStatsOptionalParams): Promise<IotHubResourceGetStatsResponse>;
364
+ importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: IotHubResourceImportDevicesOptionalParams): Promise<IotHubResourceImportDevicesResponse>;
365
+ listByResourceGroup(resourceGroupName: string, options?: IotHubResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<IotHubDescription>;
366
+ listBySubscription(options?: IotHubResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<IotHubDescription>;
367
+ listEndpointHealth(resourceGroupName: string, iotHubName: string, options?: IotHubResourceGetEndpointHealthOptionalParams): PagedAsyncIterableIterator<EndpointHealthData>;
368
+ listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: IotHubResourceListEventHubConsumerGroupsOptionalParams): PagedAsyncIterableIterator<EventHubConsumerGroupInfo>;
369
+ listJobs(resourceGroupName: string, resourceName: string, options?: IotHubResourceListJobsOptionalParams): PagedAsyncIterableIterator<JobResponse>;
370
+ listKeys(resourceGroupName: string, resourceName: string, options?: IotHubResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRule>;
371
+ listQuotaMetrics(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetQuotaMetricsOptionalParams): PagedAsyncIterableIterator<IotHubQuotaMetricInfo>;
372
+ listValidSkus(resourceGroupName: string, resourceName: string, options?: IotHubResourceGetValidSkusOptionalParams): PagedAsyncIterableIterator<IotHubSkuDescription>;
373
+ testAllRoutes(iotHubName: string, resourceGroupName: string, input: TestAllRoutesInput, options?: IotHubResourceTestAllRoutesOptionalParams): Promise<IotHubResourceTestAllRoutesResponse>;
374
+ testRoute(iotHubName: string, resourceGroupName: string, input: TestRouteInput, options?: IotHubResourceTestRouteOptionalParams): Promise<IotHubResourceTestRouteResponse>;
375
+ }
376
+
377
+ // @public
378
+ export interface IotHubResourceCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
379
+ }
380
+
381
+ // @public
382
+ export type IotHubResourceCheckNameAvailabilityResponse = IotHubNameAvailabilityInfo;
383
+
384
+ // @public
385
+ export interface IotHubResourceCreateEventHubConsumerGroupOptionalParams extends coreClient.OperationOptions {
386
+ }
387
+
388
+ // @public
389
+ export type IotHubResourceCreateEventHubConsumerGroupResponse = EventHubConsumerGroupInfo;
390
+
391
+ // @public
392
+ export interface IotHubResourceCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
393
+ ifMatch?: string;
394
+ resumeFrom?: string;
395
+ updateIntervalInMs?: number;
396
+ }
397
+
398
+ // @public
399
+ export type IotHubResourceCreateOrUpdateResponse = IotHubDescription;
400
+
401
+ // @public
402
+ export interface IotHubResourceDeleteEventHubConsumerGroupOptionalParams extends coreClient.OperationOptions {
403
+ }
404
+
405
+ // @public
406
+ export interface IotHubResourceDeleteOptionalParams extends coreClient.OperationOptions {
407
+ resumeFrom?: string;
408
+ updateIntervalInMs?: number;
409
+ }
410
+
411
+ // @public
412
+ export type IotHubResourceDeleteResponse = IotHubDescription;
413
+
414
+ // @public
415
+ export interface IotHubResourceExportDevicesOptionalParams extends coreClient.OperationOptions {
416
+ }
417
+
418
+ // @public
419
+ export type IotHubResourceExportDevicesResponse = JobResponse;
420
+
421
+ // @public
422
+ export interface IotHubResourceGetEndpointHealthNextOptionalParams extends coreClient.OperationOptions {
423
+ }
424
+
425
+ // @public
426
+ export type IotHubResourceGetEndpointHealthNextResponse = EndpointHealthDataListResult;
427
+
428
+ // @public
429
+ export interface IotHubResourceGetEndpointHealthOptionalParams extends coreClient.OperationOptions {
430
+ }
431
+
432
+ // @public
433
+ export type IotHubResourceGetEndpointHealthResponse = EndpointHealthDataListResult;
434
+
435
+ // @public
436
+ export interface IotHubResourceGetEventHubConsumerGroupOptionalParams extends coreClient.OperationOptions {
437
+ }
438
+
439
+ // @public
440
+ export type IotHubResourceGetEventHubConsumerGroupResponse = EventHubConsumerGroupInfo;
441
+
442
+ // @public
443
+ export interface IotHubResourceGetJobOptionalParams extends coreClient.OperationOptions {
444
+ }
445
+
446
+ // @public
447
+ export type IotHubResourceGetJobResponse = JobResponse;
448
+
449
+ // @public
450
+ export interface IotHubResourceGetKeysForKeyNameOptionalParams extends coreClient.OperationOptions {
451
+ }
452
+
453
+ // @public
454
+ export type IotHubResourceGetKeysForKeyNameResponse = SharedAccessSignatureAuthorizationRule;
455
+
456
+ // @public
457
+ export interface IotHubResourceGetOptionalParams extends coreClient.OperationOptions {
458
+ }
459
+
460
+ // @public
461
+ export interface IotHubResourceGetQuotaMetricsNextOptionalParams extends coreClient.OperationOptions {
462
+ }
463
+
464
+ // @public
465
+ export type IotHubResourceGetQuotaMetricsNextResponse = IotHubQuotaMetricInfoListResult;
466
+
467
+ // @public
468
+ export interface IotHubResourceGetQuotaMetricsOptionalParams extends coreClient.OperationOptions {
469
+ }
470
+
471
+ // @public
472
+ export type IotHubResourceGetQuotaMetricsResponse = IotHubQuotaMetricInfoListResult;
473
+
474
+ // @public
475
+ export type IotHubResourceGetResponse = IotHubDescription;
476
+
477
+ // @public
478
+ export interface IotHubResourceGetStatsOptionalParams extends coreClient.OperationOptions {
479
+ }
480
+
481
+ // @public
482
+ export type IotHubResourceGetStatsResponse = RegistryStatistics;
483
+
484
+ // @public
485
+ export interface IotHubResourceGetValidSkusNextOptionalParams extends coreClient.OperationOptions {
486
+ }
487
+
488
+ // @public
489
+ export type IotHubResourceGetValidSkusNextResponse = IotHubSkuDescriptionListResult;
490
+
491
+ // @public
492
+ export interface IotHubResourceGetValidSkusOptionalParams extends coreClient.OperationOptions {
493
+ }
494
+
495
+ // @public
496
+ export type IotHubResourceGetValidSkusResponse = IotHubSkuDescriptionListResult;
497
+
498
+ // @public
499
+ export interface IotHubResourceImportDevicesOptionalParams extends coreClient.OperationOptions {
500
+ }
501
+
502
+ // @public
503
+ export type IotHubResourceImportDevicesResponse = JobResponse;
504
+
505
+ // @public
506
+ export interface IotHubResourceListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
507
+ }
508
+
509
+ // @public
510
+ export type IotHubResourceListByResourceGroupNextResponse = IotHubDescriptionListResult;
511
+
512
+ // @public
513
+ export interface IotHubResourceListByResourceGroupOptionalParams extends coreClient.OperationOptions {
514
+ }
515
+
516
+ // @public
517
+ export type IotHubResourceListByResourceGroupResponse = IotHubDescriptionListResult;
518
+
519
+ // @public
520
+ export interface IotHubResourceListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
521
+ }
522
+
523
+ // @public
524
+ export type IotHubResourceListBySubscriptionNextResponse = IotHubDescriptionListResult;
525
+
526
+ // @public
527
+ export interface IotHubResourceListBySubscriptionOptionalParams extends coreClient.OperationOptions {
528
+ }
529
+
530
+ // @public
531
+ export type IotHubResourceListBySubscriptionResponse = IotHubDescriptionListResult;
532
+
533
+ // @public
534
+ export interface IotHubResourceListEventHubConsumerGroupsNextOptionalParams extends coreClient.OperationOptions {
535
+ }
536
+
537
+ // @public
538
+ export type IotHubResourceListEventHubConsumerGroupsNextResponse = EventHubConsumerGroupsListResult;
539
+
540
+ // @public
541
+ export interface IotHubResourceListEventHubConsumerGroupsOptionalParams extends coreClient.OperationOptions {
542
+ }
543
+
544
+ // @public
545
+ export type IotHubResourceListEventHubConsumerGroupsResponse = EventHubConsumerGroupsListResult;
546
+
547
+ // @public
548
+ export interface IotHubResourceListJobsNextOptionalParams extends coreClient.OperationOptions {
549
+ }
550
+
551
+ // @public
552
+ export type IotHubResourceListJobsNextResponse = JobResponseListResult;
553
+
554
+ // @public
555
+ export interface IotHubResourceListJobsOptionalParams extends coreClient.OperationOptions {
556
+ }
557
+
558
+ // @public
559
+ export type IotHubResourceListJobsResponse = JobResponseListResult;
560
+
561
+ // @public
562
+ export interface IotHubResourceListKeysNextOptionalParams extends coreClient.OperationOptions {
563
+ }
564
+
565
+ // @public
566
+ export type IotHubResourceListKeysNextResponse = SharedAccessSignatureAuthorizationRuleListResult;
567
+
568
+ // @public
569
+ export interface IotHubResourceListKeysOptionalParams extends coreClient.OperationOptions {
570
+ }
571
+
572
+ // @public
573
+ export type IotHubResourceListKeysResponse = SharedAccessSignatureAuthorizationRuleListResult;
574
+
575
+ // @public
576
+ export interface IotHubResourceTestAllRoutesOptionalParams extends coreClient.OperationOptions {
577
+ }
578
+
579
+ // @public
580
+ export type IotHubResourceTestAllRoutesResponse = TestAllRoutesResult;
581
+
582
+ // @public
583
+ export interface IotHubResourceTestRouteOptionalParams extends coreClient.OperationOptions {
584
+ }
585
+
586
+ // @public
587
+ export type IotHubResourceTestRouteResponse = TestRouteResult;
588
+
589
+ // @public
590
+ export interface IotHubResourceUpdateOptionalParams extends coreClient.OperationOptions {
591
+ resumeFrom?: string;
592
+ updateIntervalInMs?: number;
593
+ }
594
+
595
+ // @public
596
+ export type IotHubResourceUpdateResponse = IotHubDescription;
597
+
598
+ // @public
599
+ export type IotHubScaleType = "Automatic" | "Manual" | "None";
600
+
601
+ // @public
602
+ export type IotHubSku = string;
603
+
604
+ // @public
605
+ export interface IotHubSkuDescription {
606
+ capacity: IotHubCapacity;
607
+ readonly resourceType?: string;
608
+ sku: IotHubSkuInfo;
609
+ }
610
+
611
+ // @public
612
+ export interface IotHubSkuDescriptionListResult {
613
+ readonly nextLink?: string;
614
+ value?: IotHubSkuDescription[];
615
+ }
616
+
617
+ // @public
618
+ export interface IotHubSkuInfo {
619
+ capacity?: number;
620
+ name: IotHubSku;
621
+ readonly tier?: IotHubSkuTier;
622
+ }
623
+
624
+ // @public
625
+ export type IotHubSkuTier = "Free" | "Standard" | "Basic";
626
+
627
+ // @public
628
+ export type IpFilterActionType = "Accept" | "Reject";
629
+
630
+ // @public
631
+ export interface IpFilterRule {
632
+ action: IpFilterActionType;
633
+ filterName: string;
634
+ ipMask: string;
635
+ }
636
+
637
+ // @public
638
+ export interface JobResponse {
639
+ readonly endTimeUtc?: Date;
640
+ readonly failureReason?: string;
641
+ readonly jobId?: string;
642
+ readonly parentJobId?: string;
643
+ readonly startTimeUtc?: Date;
644
+ readonly status?: JobStatus;
645
+ readonly statusMessage?: string;
646
+ readonly type?: JobType;
647
+ }
648
+
649
+ // @public
650
+ export interface JobResponseListResult {
651
+ readonly nextLink?: string;
652
+ value?: JobResponse[];
653
+ }
654
+
655
+ // @public
656
+ export type JobStatus = "unknown" | "enqueued" | "running" | "completed" | "failed" | "cancelled";
657
+
658
+ // @public
659
+ export type JobType = string;
660
+
661
+ // @public
662
+ export enum KnownCapabilities {
663
+ DeviceManagement = "DeviceManagement",
664
+ None = "None"
665
+ }
666
+
667
+ // @public
668
+ export enum KnownEndpointHealthStatus {
669
+ Dead = "dead",
670
+ Healthy = "healthy",
671
+ Unhealthy = "unhealthy",
672
+ Unknown = "unknown"
673
+ }
674
+
675
+ // @public
676
+ export enum KnownIotHubReplicaRoleType {
677
+ Primary = "primary",
678
+ Secondary = "secondary"
679
+ }
680
+
681
+ // @public
682
+ export enum KnownIotHubSku {
683
+ B1 = "B1",
684
+ B2 = "B2",
685
+ B3 = "B3",
686
+ F1 = "F1",
687
+ S1 = "S1",
688
+ S2 = "S2",
689
+ S3 = "S3"
690
+ }
691
+
692
+ // @public
693
+ export enum KnownJobType {
694
+ Backup = "backup",
695
+ Export = "export",
696
+ FactoryResetDevice = "factoryResetDevice",
697
+ FirmwareUpdate = "firmwareUpdate",
698
+ Import = "import",
699
+ ReadDeviceProperties = "readDeviceProperties",
700
+ RebootDevice = "rebootDevice",
701
+ Unknown = "unknown",
702
+ UpdateDeviceConfiguration = "updateDeviceConfiguration",
703
+ WriteDeviceProperties = "writeDeviceProperties"
704
+ }
705
+
706
+ // @public
707
+ export enum KnownRouteErrorSeverity {
708
+ Error = "error",
709
+ Warning = "warning"
710
+ }
711
+
712
+ // @public
713
+ export enum KnownRoutingSource {
714
+ DeviceJobLifecycleEvents = "DeviceJobLifecycleEvents",
715
+ DeviceLifecycleEvents = "DeviceLifecycleEvents",
716
+ DeviceMessages = "DeviceMessages",
717
+ DigitalTwinChangeEvents = "DigitalTwinChangeEvents",
718
+ Invalid = "Invalid",
719
+ TwinChangeEvents = "TwinChangeEvents"
720
+ }
721
+
722
+ // @public
723
+ export enum KnownRoutingStorageContainerPropertiesEncoding {
724
+ Avro = "Avro",
725
+ AvroDeflate = "AvroDeflate",
726
+ Json = "JSON"
727
+ }
728
+
729
+ // @public
730
+ export enum KnownTestResultStatus {
731
+ False = "false",
732
+ True = "true",
733
+ Undefined = "undefined"
734
+ }
735
+
736
+ // @public
737
+ export interface MatchedRoute {
738
+ properties?: RouteProperties;
739
+ }
740
+
741
+ // @public
742
+ export interface MessagingEndpointProperties {
743
+ lockDurationAsIso8601?: string;
744
+ maxDeliveryCount?: number;
745
+ ttlAsIso8601?: string;
746
+ }
747
+
748
+ // @public
749
+ export interface Name {
750
+ localizedValue?: string;
751
+ value?: string;
752
+ }
753
+
754
+ // @public
755
+ export interface Operation {
756
+ display?: OperationDisplay;
757
+ readonly name?: string;
758
+ }
759
+
760
+ // @public
761
+ export interface OperationDisplay {
762
+ readonly description?: string;
763
+ readonly operation?: string;
764
+ readonly provider?: string;
765
+ readonly resource?: string;
766
+ }
767
+
768
+ // @public
769
+ export interface OperationInputs {
770
+ name: string;
771
+ }
772
+
773
+ // @public
774
+ export interface OperationListResult {
775
+ readonly nextLink?: string;
776
+ readonly value?: Operation[];
777
+ }
778
+
779
+ // @public
780
+ export interface Operations {
781
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
782
+ }
783
+
784
+ // @public
785
+ export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
786
+ }
787
+
788
+ // @public
789
+ export type OperationsListNextResponse = OperationListResult;
790
+
791
+ // @public
792
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
793
+ }
794
+
795
+ // @public
796
+ export type OperationsListResponse = OperationListResult;
797
+
798
+ // @public
799
+ export interface RegistryStatistics {
800
+ readonly disabledDeviceCount?: number;
801
+ readonly enabledDeviceCount?: number;
802
+ readonly totalDeviceCount?: number;
803
+ }
804
+
805
+ // @public
806
+ export interface Resource {
807
+ readonly id?: string;
808
+ location: string;
809
+ readonly name?: string;
810
+ tags?: {
811
+ [propertyName: string]: string;
812
+ };
813
+ readonly type?: string;
814
+ }
815
+
816
+ // @public
817
+ export interface ResourceProviderCommon {
818
+ getSubscriptionQuota(options?: ResourceProviderCommonGetSubscriptionQuotaOptionalParams): Promise<ResourceProviderCommonGetSubscriptionQuotaResponse>;
819
+ }
820
+
821
+ // @public
822
+ export interface ResourceProviderCommonGetSubscriptionQuotaOptionalParams extends coreClient.OperationOptions {
823
+ }
824
+
825
+ // @public
826
+ export type ResourceProviderCommonGetSubscriptionQuotaResponse = UserSubscriptionQuotaListResult;
827
+
828
+ // @public
829
+ export interface RouteCompilationError {
830
+ location?: RouteErrorRange;
831
+ message?: string;
832
+ severity?: RouteErrorSeverity;
833
+ }
834
+
835
+ // @public
836
+ export interface RouteErrorPosition {
837
+ column?: number;
838
+ line?: number;
839
+ }
840
+
841
+ // @public
842
+ export interface RouteErrorRange {
843
+ end?: RouteErrorPosition;
844
+ start?: RouteErrorPosition;
845
+ }
846
+
847
+ // @public
848
+ export type RouteErrorSeverity = string;
849
+
850
+ // @public
851
+ export interface RouteProperties {
852
+ condition?: string;
853
+ endpointNames: string[];
854
+ isEnabled: boolean;
855
+ name: string;
856
+ source: RoutingSource;
857
+ }
858
+
859
+ // @public
860
+ export interface RoutingEndpoints {
861
+ eventHubs?: RoutingEventHubProperties[];
862
+ serviceBusQueues?: RoutingServiceBusQueueEndpointProperties[];
863
+ serviceBusTopics?: RoutingServiceBusTopicEndpointProperties[];
864
+ storageContainers?: RoutingStorageContainerProperties[];
865
+ }
866
+
867
+ // @public
868
+ export interface RoutingEventHubProperties {
869
+ connectionString: string;
870
+ name: string;
871
+ resourceGroup?: string;
872
+ subscriptionId?: string;
873
+ }
874
+
875
+ // @public
876
+ export interface RoutingMessage {
877
+ appProperties?: {
878
+ [propertyName: string]: string;
879
+ };
880
+ body?: string;
881
+ systemProperties?: {
882
+ [propertyName: string]: string;
883
+ };
884
+ }
885
+
886
+ // @public
887
+ export interface RoutingProperties {
888
+ endpoints?: RoutingEndpoints;
889
+ enrichments?: EnrichmentProperties[];
890
+ fallbackRoute?: FallbackRouteProperties;
891
+ routes?: RouteProperties[];
892
+ }
893
+
894
+ // @public
895
+ export interface RoutingServiceBusQueueEndpointProperties {
896
+ connectionString: string;
897
+ name: string;
898
+ resourceGroup?: string;
899
+ subscriptionId?: string;
900
+ }
901
+
902
+ // @public
903
+ export interface RoutingServiceBusTopicEndpointProperties {
904
+ connectionString: string;
905
+ name: string;
906
+ resourceGroup?: string;
907
+ subscriptionId?: string;
908
+ }
909
+
910
+ // @public
911
+ export type RoutingSource = string;
912
+
913
+ // @public
914
+ export interface RoutingStorageContainerProperties {
915
+ batchFrequencyInSeconds?: number;
916
+ connectionString: string;
917
+ containerName: string;
918
+ encoding?: RoutingStorageContainerPropertiesEncoding;
919
+ fileNameFormat?: string;
920
+ maxChunkSizeInBytes?: number;
921
+ name: string;
922
+ resourceGroup?: string;
923
+ subscriptionId?: string;
924
+ }
925
+
926
+ // @public
927
+ export type RoutingStorageContainerPropertiesEncoding = string;
928
+
929
+ // @public
930
+ export interface RoutingTwin {
931
+ // (undocumented)
932
+ properties?: RoutingTwinProperties;
933
+ tags?: Record<string, unknown>;
934
+ }
935
+
936
+ // @public (undocumented)
937
+ export interface RoutingTwinProperties {
938
+ desired?: Record<string, unknown>;
939
+ reported?: Record<string, unknown>;
940
+ }
941
+
942
+ // @public
943
+ export interface SharedAccessSignatureAuthorizationRule {
944
+ keyName: string;
945
+ primaryKey?: string;
946
+ rights: AccessRights;
947
+ secondaryKey?: string;
948
+ }
949
+
950
+ // @public
951
+ export interface SharedAccessSignatureAuthorizationRuleListResult {
952
+ readonly nextLink?: string;
953
+ value?: SharedAccessSignatureAuthorizationRule[];
954
+ }
955
+
956
+ // @public
957
+ export interface StorageEndpointProperties {
958
+ connectionString: string;
959
+ containerName: string;
960
+ sasTtlAsIso8601?: string;
961
+ }
962
+
963
+ // @public
964
+ export interface TagsResource {
965
+ tags?: {
966
+ [propertyName: string]: string;
967
+ };
968
+ }
969
+
970
+ // @public
971
+ export interface TestAllRoutesInput {
972
+ message?: RoutingMessage;
973
+ routingSource?: RoutingSource;
974
+ twin?: RoutingTwin;
975
+ }
976
+
977
+ // @public
978
+ export interface TestAllRoutesResult {
979
+ routes?: MatchedRoute[];
980
+ }
981
+
982
+ // @public
983
+ export type TestResultStatus = string;
984
+
985
+ // @public
986
+ export interface TestRouteInput {
987
+ message?: RoutingMessage;
988
+ route: RouteProperties;
989
+ twin?: RoutingTwin;
990
+ }
991
+
992
+ // @public
993
+ export interface TestRouteResult {
994
+ details?: TestRouteResultDetails;
995
+ result?: TestResultStatus;
996
+ }
997
+
998
+ // @public
999
+ export interface TestRouteResultDetails {
1000
+ compilationErrors?: RouteCompilationError[];
1001
+ }
1002
+
1003
+ // @public
1004
+ export interface UserSubscriptionQuota {
1005
+ currentValue?: number;
1006
+ id?: string;
1007
+ limit?: number;
1008
+ name?: Name;
1009
+ type?: string;
1010
+ unit?: string;
1011
+ }
1012
+
1013
+ // @public
1014
+ export interface UserSubscriptionQuotaListResult {
1015
+ readonly nextLink?: string;
1016
+ // (undocumented)
1017
+ value?: UserSubscriptionQuota[];
1018
+ }
1019
+
1020
+ // (No @packageDocumentation comment for this package)
1021
+
1022
+ ```