@azure/arm-timeseriesinsights 2.1.0-alpha.20221215.1 → 2.1.0-alpha.20221216.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.
- package/CHANGELOG.md +39 -12
- package/dist/index.js +186 -59
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/dist-esm/samples-dev/accessPoliciesCreateOrUpdateSample.js +10 -3
- package/dist-esm/samples-dev/accessPoliciesCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/accessPoliciesDeleteSample.js +10 -3
- package/dist-esm/samples-dev/accessPoliciesDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/accessPoliciesGetSample.js +10 -3
- package/dist-esm/samples-dev/accessPoliciesGetSample.js.map +1 -1
- package/dist-esm/samples-dev/accessPoliciesListByEnvironmentSample.js +10 -3
- package/dist-esm/samples-dev/accessPoliciesListByEnvironmentSample.js.map +1 -1
- package/dist-esm/samples-dev/accessPoliciesUpdateSample.js +10 -3
- package/dist-esm/samples-dev/accessPoliciesUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/environmentsCreateOrUpdateSample.js +10 -3
- package/dist-esm/samples-dev/environmentsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/environmentsDeleteSample.js +10 -3
- package/dist-esm/samples-dev/environmentsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/environmentsGetSample.js +10 -3
- package/dist-esm/samples-dev/environmentsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/environmentsListByResourceGroupSample.js +10 -3
- package/dist-esm/samples-dev/environmentsListByResourceGroupSample.js.map +1 -1
- package/dist-esm/samples-dev/environmentsListBySubscriptionSample.js +9 -2
- package/dist-esm/samples-dev/environmentsListBySubscriptionSample.js.map +1 -1
- package/dist-esm/samples-dev/environmentsUpdateSample.js +10 -3
- package/dist-esm/samples-dev/environmentsUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/eventSourcesCreateOrUpdateSample.js +13 -6
- package/dist-esm/samples-dev/eventSourcesCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/eventSourcesDeleteSample.js +10 -3
- package/dist-esm/samples-dev/eventSourcesDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/eventSourcesGetSample.js +10 -3
- package/dist-esm/samples-dev/eventSourcesGetSample.js.map +1 -1
- package/dist-esm/samples-dev/eventSourcesListByEnvironmentSample.js +10 -3
- package/dist-esm/samples-dev/eventSourcesListByEnvironmentSample.js.map +1 -1
- package/dist-esm/samples-dev/eventSourcesUpdateSample.js +10 -3
- package/dist-esm/samples-dev/eventSourcesUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/operationsListSample.js +10 -2
- package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsCreateOrUpdateSample.js +10 -3
- package/dist-esm/samples-dev/privateEndpointConnectionsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js +10 -3
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js +10 -3
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsListByEnvironmentSample.js +10 -3
- package/dist-esm/samples-dev/privateEndpointConnectionsListByEnvironmentSample.js.map +1 -1
- package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js +10 -3
- package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js.map +1 -1
- package/dist-esm/samples-dev/referenceDataSetsCreateOrUpdateSample.js +10 -3
- package/dist-esm/samples-dev/referenceDataSetsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/referenceDataSetsDeleteSample.js +10 -3
- package/dist-esm/samples-dev/referenceDataSetsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/referenceDataSetsGetSample.js +10 -3
- package/dist-esm/samples-dev/referenceDataSetsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/referenceDataSetsListByEnvironmentSample.js +10 -3
- package/dist-esm/samples-dev/referenceDataSetsListByEnvironmentSample.js.map +1 -1
- package/dist-esm/samples-dev/referenceDataSetsUpdateSample.js +10 -3
- package/dist-esm/samples-dev/referenceDataSetsUpdateSample.js.map +1 -1
- package/dist-esm/src/index.d.ts +1 -0
- package/dist-esm/src/index.d.ts.map +1 -1
- package/dist-esm/src/index.js +1 -0
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/models/index.d.ts +138 -68
- package/dist-esm/src/models/index.d.ts.map +1 -1
- package/dist-esm/src/models/index.js +50 -0
- package/dist-esm/src/models/index.js.map +1 -1
- package/dist-esm/src/models/mappers.d.ts +10 -10
- package/dist-esm/src/models/mappers.js +28 -28
- package/dist-esm/src/models/mappers.js.map +1 -1
- package/dist-esm/src/operations/operations.d.ts.map +1 -1
- package/dist-esm/src/operations/operations.js +19 -8
- package/dist-esm/src/operations/operations.js.map +1 -1
- package/dist-esm/src/operations/privateLinkResources.d.ts.map +1 -1
- package/dist-esm/src/operations/privateLinkResources.js +8 -4
- package/dist-esm/src/operations/privateLinkResources.js.map +1 -1
- package/dist-esm/src/pagingHelper.d.ts +13 -0
- package/dist-esm/src/pagingHelper.d.ts.map +1 -0
- package/dist-esm/src/pagingHelper.js +32 -0
- package/dist-esm/src/pagingHelper.js.map +1 -0
- package/dist-esm/src/timeSeriesInsightsClient.d.ts +2 -0
- package/dist-esm/src/timeSeriesInsightsClient.d.ts.map +1 -1
- package/dist-esm/src/timeSeriesInsightsClient.js +49 -18
- package/dist-esm/src/timeSeriesInsightsClient.js.map +1 -1
- package/dist-esm/test/sampleTest.js +11 -13
- package/dist-esm/test/sampleTest.js.map +1 -1
- package/package.json +13 -8
- package/review/arm-timeseriesinsights.api.md +143 -178
- package/src/index.ts +1 -0
- package/src/models/index.ts +159 -70
- package/src/models/mappers.ts +28 -28
- package/src/operations/operations.ts +21 -9
- package/src/operations/privateLinkResources.ts +11 -5
- package/src/pagingHelper.ts +39 -0
- package/src/timeSeriesInsightsClient.ts +60 -20
- package/types/arm-timeseriesinsights.d.ts +149 -68
package/src/models/index.ts
CHANGED
@@ -425,48 +425,51 @@ export interface EventSourceMutableProperties {
|
|
425
425
|
}
|
426
426
|
|
427
427
|
/** Parameters supplied to the CreateOrUpdate Environment operation. */
|
428
|
-
export
|
428
|
+
export interface EnvironmentCreateOrUpdateParameters
|
429
|
+
extends CreateOrUpdateTrackedResourceProperties {
|
429
430
|
/** The kind of the environment. */
|
430
431
|
kind: EnvironmentKind;
|
431
432
|
/** The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. */
|
432
433
|
sku: Sku;
|
433
|
-
}
|
434
|
+
}
|
434
435
|
|
435
436
|
/** Parameters supplied to the Create or Update Event Source operation. */
|
436
|
-
export
|
437
|
+
export interface EventSourceCreateOrUpdateParameters
|
438
|
+
extends CreateOrUpdateTrackedResourceProperties {
|
437
439
|
/** The kind of the event source. */
|
438
440
|
kind: EventSourceKind;
|
439
441
|
/** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
|
440
442
|
localTimestamp?: LocalTimestamp;
|
441
|
-
}
|
443
|
+
}
|
442
444
|
|
443
|
-
export
|
445
|
+
export interface ReferenceDataSetCreateOrUpdateParameters
|
446
|
+
extends CreateOrUpdateTrackedResourceProperties {
|
444
447
|
/** The list of key properties for the reference data set. */
|
445
448
|
keyProperties: ReferenceDataSetKeyProperty[];
|
446
449
|
/** The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used. */
|
447
450
|
dataStringComparisonBehavior?: DataStringComparisonBehavior;
|
448
|
-
}
|
451
|
+
}
|
449
452
|
|
450
453
|
/** Time Series Insights resource that is tracked by Azure Resource Manager. */
|
451
|
-
export
|
454
|
+
export interface TrackedResource extends Resource {
|
452
455
|
/** Resource location */
|
453
456
|
location: string;
|
454
457
|
/** Resource tags */
|
455
458
|
tags?: { [propertyName: string]: string };
|
456
|
-
}
|
459
|
+
}
|
457
460
|
|
458
461
|
/** An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs. */
|
459
|
-
export
|
462
|
+
export interface AccessPolicyResource extends Resource {
|
460
463
|
/** The objectId of the principal in Azure Active Directory. */
|
461
464
|
principalObjectId?: string;
|
462
465
|
/** An description of the access policy. */
|
463
466
|
description?: string;
|
464
467
|
/** The list of roles the principal is assigned on the environment. */
|
465
468
|
roles?: AccessPolicyRole[];
|
466
|
-
}
|
469
|
+
}
|
467
470
|
|
468
471
|
/** The Private Endpoint Connection resource. */
|
469
|
-
export
|
472
|
+
export interface PrivateEndpointConnection extends Resource {
|
470
473
|
/**
|
471
474
|
* Provisioning state of the private endpoint connection.
|
472
475
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -478,10 +481,10 @@ export type PrivateEndpointConnection = Resource & {
|
|
478
481
|
groupIds?: string[];
|
479
482
|
/** A collection of information about the state of the connection between service consumer and provider. */
|
480
483
|
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
|
481
|
-
}
|
484
|
+
}
|
482
485
|
|
483
486
|
/** A private link resource */
|
484
|
-
export
|
487
|
+
export interface PrivateLinkResource extends Resource {
|
485
488
|
/**
|
486
489
|
* The private link resource group id.
|
487
490
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -494,10 +497,11 @@ export type PrivateLinkResource = Resource & {
|
|
494
497
|
readonly requiredMembers?: string[];
|
495
498
|
/** The private link resource Private link DNS zone name. */
|
496
499
|
requiredZoneNames?: string[];
|
497
|
-
}
|
500
|
+
}
|
498
501
|
|
499
502
|
/** Parameters supplied to the Update Environment operation to update a Gen1 environment. */
|
500
|
-
export
|
503
|
+
export interface Gen1EnvironmentUpdateParameters
|
504
|
+
extends EnvironmentUpdateParameters {
|
501
505
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
502
506
|
kind: "Gen1";
|
503
507
|
/** The sku of the environment. */
|
@@ -506,44 +510,48 @@ export type Gen1EnvironmentUpdateParameters = EnvironmentUpdateParameters & {
|
|
506
510
|
dataRetentionTime?: string;
|
507
511
|
/** The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. */
|
508
512
|
storageLimitExceededBehavior?: StorageLimitExceededBehavior;
|
509
|
-
}
|
513
|
+
}
|
510
514
|
|
511
515
|
/** Parameters supplied to the Update Environment operation to update a Gen2 environment. */
|
512
|
-
export
|
516
|
+
export interface Gen2EnvironmentUpdateParameters
|
517
|
+
extends EnvironmentUpdateParameters {
|
513
518
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
514
519
|
kind: "Gen2";
|
515
520
|
/** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
|
516
521
|
storageConfiguration?: Gen2StorageConfigurationMutableProperties;
|
517
522
|
/** The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query. */
|
518
523
|
warmStoreConfiguration?: WarmStoreConfigurationProperties;
|
519
|
-
}
|
524
|
+
}
|
520
525
|
|
521
526
|
/** Parameters supplied to the Update Event Source operation to update an EventHub event source. */
|
522
|
-
export
|
527
|
+
export interface EventHubEventSourceUpdateParameters
|
528
|
+
extends EventSourceUpdateParameters {
|
523
529
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
524
530
|
kind: "Microsoft.EventHub";
|
525
531
|
/** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
|
526
532
|
timestampPropertyName?: string;
|
527
533
|
/** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
|
528
534
|
sharedAccessKey?: string;
|
529
|
-
}
|
535
|
+
}
|
530
536
|
|
531
537
|
/** Parameters supplied to the Update Event Source operation to update an IoTHub event source. */
|
532
|
-
export
|
538
|
+
export interface IoTHubEventSourceUpdateParameters
|
539
|
+
extends EventSourceUpdateParameters {
|
533
540
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
534
541
|
kind: "Microsoft.IoTHub";
|
535
542
|
/** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
|
536
543
|
timestampPropertyName?: string;
|
537
544
|
/** The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
|
538
545
|
sharedAccessKey?: string;
|
539
|
-
}
|
546
|
+
}
|
540
547
|
|
541
548
|
/** Properties of the reference data set. */
|
542
|
-
export
|
543
|
-
|
549
|
+
export interface ReferenceDataSetResourceProperties
|
550
|
+
extends ReferenceDataSetCreationProperties,
|
551
|
+
ResourceProperties {}
|
544
552
|
|
545
553
|
/** Properties of the environment. */
|
546
|
-
export
|
554
|
+
export interface EnvironmentResourceProperties extends ResourceProperties {
|
547
555
|
/**
|
548
556
|
* An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
|
549
557
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -559,10 +567,10 @@ export type EnvironmentResourceProperties = ResourceProperties & {
|
|
559
567
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
560
568
|
*/
|
561
569
|
readonly status?: EnvironmentStatus;
|
562
|
-
}
|
570
|
+
}
|
563
571
|
|
564
572
|
/** Properties of the event source. */
|
565
|
-
export
|
573
|
+
export interface EventSourceCommonProperties extends ResourceProperties {
|
566
574
|
/** The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used. */
|
567
575
|
timestampPropertyName?: string;
|
568
576
|
/** An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */
|
@@ -571,36 +579,45 @@ export type EventSourceCommonProperties = ResourceProperties & {
|
|
571
579
|
type?: IngressStartAtType;
|
572
580
|
/** ISO8601 UTC datetime with seconds precision (milliseconds are optional), specifying the date and time that will be the starting point for Events to be consumed. */
|
573
581
|
time?: string;
|
574
|
-
}
|
582
|
+
}
|
575
583
|
|
576
584
|
/** Properties of the Gen1 environment. */
|
577
|
-
export
|
578
|
-
|
585
|
+
export interface Gen1EnvironmentResourceProperties
|
586
|
+
extends Gen1EnvironmentCreationProperties,
|
587
|
+
EnvironmentResourceProperties {}
|
579
588
|
|
580
589
|
/** An object that represents a set of mutable EventHub event source resource properties. */
|
581
|
-
export
|
590
|
+
export interface EventHubEventSourceMutableProperties
|
591
|
+
extends EventSourceMutableProperties {
|
582
592
|
/** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
|
583
593
|
sharedAccessKey?: string;
|
584
|
-
}
|
594
|
+
}
|
585
595
|
|
586
596
|
/** An object that represents a set of mutable IoTHub event source resource properties. */
|
587
|
-
export
|
597
|
+
export interface IoTHubEventSourceMutableProperties
|
598
|
+
extends EventSourceMutableProperties {
|
588
599
|
/** The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
|
589
600
|
sharedAccessKey?: string;
|
590
|
-
}
|
601
|
+
}
|
591
602
|
|
592
603
|
/** Parameters supplied to the Create or Update Environment operation for a Gen1 environment. */
|
593
|
-
export
|
604
|
+
export interface Gen1EnvironmentCreateOrUpdateParameters
|
605
|
+
extends EnvironmentCreateOrUpdateParameters {
|
606
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
607
|
+
kind: "Gen1";
|
594
608
|
/** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
|
595
609
|
dataRetentionTime: string;
|
596
610
|
/** The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. */
|
597
611
|
storageLimitExceededBehavior?: StorageLimitExceededBehavior;
|
598
612
|
/** The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported. */
|
599
613
|
partitionKeyProperties?: TimeSeriesIdProperty[];
|
600
|
-
}
|
614
|
+
}
|
601
615
|
|
602
616
|
/** Parameters supplied to the Create or Update Environment operation for a Gen2 environment. */
|
603
|
-
export
|
617
|
+
export interface Gen2EnvironmentCreateOrUpdateParameters
|
618
|
+
extends EnvironmentCreateOrUpdateParameters {
|
619
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
620
|
+
kind: "Gen2";
|
604
621
|
/** The list of event properties which will be used to define the environment's time series id. */
|
605
622
|
timeSeriesIdProperties: TimeSeriesIdProperty[];
|
606
623
|
/** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
|
@@ -614,10 +631,13 @@ export type Gen2EnvironmentCreateOrUpdateParameters = EnvironmentCreateOrUpdateP
|
|
614
631
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
615
632
|
*/
|
616
633
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
617
|
-
}
|
634
|
+
}
|
618
635
|
|
619
636
|
/** Parameters supplied to the Create or Update Event Source operation for an EventHub event source. */
|
620
|
-
export
|
637
|
+
export interface EventHubEventSourceCreateOrUpdateParameters
|
638
|
+
extends EventSourceCreateOrUpdateParameters {
|
639
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
640
|
+
kind: "Microsoft.EventHub";
|
621
641
|
/**
|
622
642
|
* Provisioning state of the resource.
|
623
643
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -648,10 +668,13 @@ export type EventHubEventSourceCreateOrUpdateParameters = EventSourceCreateOrUpd
|
|
648
668
|
keyName: string;
|
649
669
|
/** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
|
650
670
|
sharedAccessKey: string;
|
651
|
-
}
|
671
|
+
}
|
652
672
|
|
653
673
|
/** Parameters supplied to the Create or Update Event Source operation for an IoTHub event source. */
|
654
|
-
export
|
674
|
+
export interface IoTHubEventSourceCreateOrUpdateParameters
|
675
|
+
extends EventSourceCreateOrUpdateParameters {
|
676
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
677
|
+
kind: "Microsoft.IoTHub";
|
655
678
|
/**
|
656
679
|
* Provisioning state of the resource.
|
657
680
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -680,24 +703,24 @@ export type IoTHubEventSourceCreateOrUpdateParameters = EventSourceCreateOrUpdat
|
|
680
703
|
keyName: string;
|
681
704
|
/** The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
|
682
705
|
sharedAccessKey: string;
|
683
|
-
}
|
706
|
+
}
|
684
707
|
|
685
708
|
/** An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. */
|
686
|
-
export
|
709
|
+
export interface EnvironmentResource extends TrackedResource {
|
687
710
|
/** The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. */
|
688
711
|
sku: Sku;
|
689
712
|
/** The kind of the environment. */
|
690
713
|
kind: EnvironmentResourceKind;
|
691
|
-
}
|
714
|
+
}
|
692
715
|
|
693
716
|
/** An environment receives data from one or more event sources. Each event source has associated connection info that allows the Time Series Insights ingress pipeline to connect to and pull data from the event source */
|
694
|
-
export
|
717
|
+
export interface EventSourceResource extends TrackedResource {
|
695
718
|
/** The kind of the event source. */
|
696
719
|
kind: EventSourceResourceKind;
|
697
|
-
}
|
720
|
+
}
|
698
721
|
|
699
722
|
/** A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs. */
|
700
|
-
export
|
723
|
+
export interface ReferenceDataSetResource extends TrackedResource {
|
701
724
|
/** The list of key properties for the reference data set. */
|
702
725
|
keyProperties?: ReferenceDataSetKeyProperty[];
|
703
726
|
/** The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used. */
|
@@ -712,10 +735,11 @@ export type ReferenceDataSetResource = TrackedResource & {
|
|
712
735
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
713
736
|
*/
|
714
737
|
readonly creationTime?: Date;
|
715
|
-
}
|
738
|
+
}
|
716
739
|
|
717
740
|
/** Properties of the Gen2 environment. */
|
718
|
-
export
|
741
|
+
export interface Gen2EnvironmentResourceProperties
|
742
|
+
extends EnvironmentResourceProperties {
|
719
743
|
/** The list of event properties which will be used to define the environment's time series id. */
|
720
744
|
timeSeriesIdProperties: TimeSeriesIdProperty[];
|
721
745
|
/** The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data. */
|
@@ -729,16 +753,19 @@ export type Gen2EnvironmentResourceProperties = EnvironmentResourceProperties &
|
|
729
753
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
730
754
|
*/
|
731
755
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
732
|
-
}
|
756
|
+
}
|
733
757
|
|
734
758
|
/** Properties of an event source that reads events from an event broker in Azure. */
|
735
|
-
export
|
759
|
+
export interface AzureEventSourceProperties
|
760
|
+
extends EventSourceCommonProperties {
|
736
761
|
/** The resource id of the event source in Azure Resource Manager. */
|
737
762
|
eventSourceResourceId: string;
|
738
|
-
}
|
763
|
+
}
|
739
764
|
|
740
765
|
/** An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen1 environments have data retention limits. */
|
741
|
-
export
|
766
|
+
export interface Gen1EnvironmentResource extends EnvironmentResource {
|
767
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
768
|
+
kind: "Gen1";
|
742
769
|
/** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
|
743
770
|
dataRetentionTime: string;
|
744
771
|
/** The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If "PauseIngress" is specified, new events will not be read from the event source. If "PurgeOldData" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData. */
|
@@ -770,10 +797,12 @@ export type Gen1EnvironmentResource = EnvironmentResource & {
|
|
770
797
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
771
798
|
*/
|
772
799
|
readonly status?: EnvironmentStatus;
|
773
|
-
}
|
800
|
+
}
|
774
801
|
|
775
802
|
/** An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen2 environments do not have set data retention limits. */
|
776
|
-
export
|
803
|
+
export interface Gen2EnvironmentResource extends EnvironmentResource {
|
804
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
805
|
+
kind: "Gen2";
|
777
806
|
/**
|
778
807
|
* Provisioning state of the resource.
|
779
808
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -812,10 +841,12 @@ export type Gen2EnvironmentResource = EnvironmentResource & {
|
|
812
841
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
813
842
|
*/
|
814
843
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
815
|
-
}
|
844
|
+
}
|
816
845
|
|
817
846
|
/** An event source that receives its data from an Azure EventHub. */
|
818
|
-
export
|
847
|
+
export interface EventHubEventSourceResource extends EventSourceResource {
|
848
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
849
|
+
kind: "Microsoft.EventHub";
|
819
850
|
/**
|
820
851
|
* Provisioning state of the resource.
|
821
852
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -844,10 +875,12 @@ export type EventHubEventSourceResource = EventSourceResource & {
|
|
844
875
|
consumerGroupName: string;
|
845
876
|
/** The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub. */
|
846
877
|
keyName: string;
|
847
|
-
}
|
878
|
+
}
|
848
879
|
|
849
880
|
/** An event source that receives its data from an Azure IoTHub. */
|
850
|
-
export
|
881
|
+
export interface IoTHubEventSourceResource extends EventSourceResource {
|
882
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
883
|
+
kind: "Microsoft.IoTHub";
|
851
884
|
/**
|
852
885
|
* Provisioning state of the resource.
|
853
886
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -874,10 +907,11 @@ export type IoTHubEventSourceResource = EventSourceResource & {
|
|
874
907
|
consumerGroupName: string;
|
875
908
|
/** The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub. */
|
876
909
|
keyName: string;
|
877
|
-
}
|
910
|
+
}
|
878
911
|
|
879
912
|
/** Properties of the EventHub event source. */
|
880
|
-
export
|
913
|
+
export interface EventHubEventSourceCommonProperties
|
914
|
+
extends AzureEventSourceProperties {
|
881
915
|
/** The name of the service bus that contains the event hub. */
|
882
916
|
serviceBusNamespace: string;
|
883
917
|
/** The name of the event hub. */
|
@@ -886,39 +920,46 @@ export type EventHubEventSourceCommonProperties = AzureEventSourceProperties & {
|
|
886
920
|
consumerGroupName: string;
|
887
921
|
/** The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub. */
|
888
922
|
keyName: string;
|
889
|
-
}
|
923
|
+
}
|
890
924
|
|
891
925
|
/** Properties of the IoTHub event source. */
|
892
|
-
export
|
926
|
+
export interface IoTHubEventSourceCommonProperties
|
927
|
+
extends AzureEventSourceProperties {
|
893
928
|
/** The name of the iot hub. */
|
894
929
|
iotHubName: string;
|
895
930
|
/** The name of the iot hub's consumer group that holds the partitions from which events will be read. */
|
896
931
|
consumerGroupName: string;
|
897
932
|
/** The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub. */
|
898
933
|
keyName: string;
|
899
|
-
}
|
934
|
+
}
|
900
935
|
|
901
936
|
/** Properties of the EventHub event source that are required on create or update requests. */
|
902
|
-
export
|
937
|
+
export interface EventHubEventSourceCreationProperties
|
938
|
+
extends EventHubEventSourceCommonProperties {
|
903
939
|
/** The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses. */
|
904
940
|
sharedAccessKey: string;
|
905
|
-
}
|
941
|
+
}
|
906
942
|
|
907
943
|
/** Properties of the EventHub event source resource. */
|
908
|
-
export
|
944
|
+
export interface EventHubEventSourceResourceProperties
|
945
|
+
extends EventHubEventSourceCommonProperties {}
|
909
946
|
|
910
947
|
/** Properties of the IoTHub event source that are required on create or update requests. */
|
911
|
-
export
|
948
|
+
export interface IoTHubEventSourceCreationProperties
|
949
|
+
extends IoTHubEventSourceCommonProperties {
|
912
950
|
/** The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses. */
|
913
951
|
sharedAccessKey: string;
|
914
|
-
}
|
952
|
+
}
|
915
953
|
|
916
954
|
/** Properties of the IoTHub event source resource. */
|
917
|
-
export
|
955
|
+
export interface IoTHubEventSourceResourceProperties
|
956
|
+
extends IoTHubEventSourceCommonProperties {}
|
918
957
|
|
919
958
|
/** Known values of {@link EnvironmentKind} that the service accepts. */
|
920
959
|
export enum KnownEnvironmentKind {
|
960
|
+
/** Gen1 */
|
921
961
|
Gen1 = "Gen1",
|
962
|
+
/** Gen2 */
|
922
963
|
Gen2 = "Gen2"
|
923
964
|
}
|
924
965
|
|
@@ -934,9 +975,13 @@ export type EnvironmentKind = string;
|
|
934
975
|
|
935
976
|
/** Known values of {@link SkuName} that the service accepts. */
|
936
977
|
export enum KnownSkuName {
|
978
|
+
/** S1 */
|
937
979
|
S1 = "S1",
|
980
|
+
/** S2 */
|
938
981
|
S2 = "S2",
|
982
|
+
/** P1 */
|
939
983
|
P1 = "P1",
|
984
|
+
/** L1 */
|
940
985
|
L1 = "L1"
|
941
986
|
}
|
942
987
|
|
@@ -954,7 +999,9 @@ export type SkuName = string;
|
|
954
999
|
|
955
1000
|
/** Known values of {@link EnvironmentResourceKind} that the service accepts. */
|
956
1001
|
export enum KnownEnvironmentResourceKind {
|
1002
|
+
/** Gen1 */
|
957
1003
|
Gen1 = "Gen1",
|
1004
|
+
/** Gen2 */
|
958
1005
|
Gen2 = "Gen2"
|
959
1006
|
}
|
960
1007
|
|
@@ -970,7 +1017,9 @@ export type EnvironmentResourceKind = string;
|
|
970
1017
|
|
971
1018
|
/** Known values of {@link EventSourceKind} that the service accepts. */
|
972
1019
|
export enum KnownEventSourceKind {
|
1020
|
+
/** MicrosoftEventHub */
|
973
1021
|
MicrosoftEventHub = "Microsoft.EventHub",
|
1022
|
+
/** MicrosoftIoTHub */
|
974
1023
|
MicrosoftIoTHub = "Microsoft.IoTHub"
|
975
1024
|
}
|
976
1025
|
|
@@ -986,6 +1035,7 @@ export type EventSourceKind = string;
|
|
986
1035
|
|
987
1036
|
/** Known values of {@link LocalTimestampFormat} that the service accepts. */
|
988
1037
|
export enum KnownLocalTimestampFormat {
|
1038
|
+
/** Embedded */
|
989
1039
|
Embedded = "Embedded"
|
990
1040
|
}
|
991
1041
|
|
@@ -1000,7 +1050,9 @@ export type LocalTimestampFormat = string;
|
|
1000
1050
|
|
1001
1051
|
/** Known values of {@link EventSourceResourceKind} that the service accepts. */
|
1002
1052
|
export enum KnownEventSourceResourceKind {
|
1053
|
+
/** MicrosoftEventHub */
|
1003
1054
|
MicrosoftEventHub = "Microsoft.EventHub",
|
1055
|
+
/** MicrosoftIoTHub */
|
1004
1056
|
MicrosoftIoTHub = "Microsoft.IoTHub"
|
1005
1057
|
}
|
1006
1058
|
|
@@ -1016,9 +1068,13 @@ export type EventSourceResourceKind = string;
|
|
1016
1068
|
|
1017
1069
|
/** Known values of {@link ReferenceDataKeyPropertyType} that the service accepts. */
|
1018
1070
|
export enum KnownReferenceDataKeyPropertyType {
|
1071
|
+
/** String */
|
1019
1072
|
String = "String",
|
1073
|
+
/** Double */
|
1020
1074
|
Double = "Double",
|
1075
|
+
/** Bool */
|
1021
1076
|
Bool = "Bool",
|
1077
|
+
/** DateTime */
|
1022
1078
|
DateTime = "DateTime"
|
1023
1079
|
}
|
1024
1080
|
|
@@ -1036,7 +1092,9 @@ export type ReferenceDataKeyPropertyType = string;
|
|
1036
1092
|
|
1037
1093
|
/** Known values of {@link DataStringComparisonBehavior} that the service accepts. */
|
1038
1094
|
export enum KnownDataStringComparisonBehavior {
|
1095
|
+
/** Ordinal */
|
1039
1096
|
Ordinal = "Ordinal",
|
1097
|
+
/** OrdinalIgnoreCase */
|
1040
1098
|
OrdinalIgnoreCase = "OrdinalIgnoreCase"
|
1041
1099
|
}
|
1042
1100
|
|
@@ -1052,11 +1110,17 @@ export type DataStringComparisonBehavior = string;
|
|
1052
1110
|
|
1053
1111
|
/** Known values of {@link ProvisioningState} that the service accepts. */
|
1054
1112
|
export enum KnownProvisioningState {
|
1113
|
+
/** Accepted */
|
1055
1114
|
Accepted = "Accepted",
|
1115
|
+
/** Creating */
|
1056
1116
|
Creating = "Creating",
|
1117
|
+
/** Updating */
|
1057
1118
|
Updating = "Updating",
|
1119
|
+
/** Succeeded */
|
1058
1120
|
Succeeded = "Succeeded",
|
1121
|
+
/** Failed */
|
1059
1122
|
Failed = "Failed",
|
1123
|
+
/** Deleting */
|
1060
1124
|
Deleting = "Deleting"
|
1061
1125
|
}
|
1062
1126
|
|
@@ -1076,7 +1140,9 @@ export type ProvisioningState = string;
|
|
1076
1140
|
|
1077
1141
|
/** Known values of {@link AccessPolicyRole} that the service accepts. */
|
1078
1142
|
export enum KnownAccessPolicyRole {
|
1143
|
+
/** Reader */
|
1079
1144
|
Reader = "Reader",
|
1145
|
+
/** Contributor */
|
1080
1146
|
Contributor = "Contributor"
|
1081
1147
|
}
|
1082
1148
|
|
@@ -1092,9 +1158,13 @@ export type AccessPolicyRole = string;
|
|
1092
1158
|
|
1093
1159
|
/** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
|
1094
1160
|
export enum KnownPrivateEndpointConnectionProvisioningState {
|
1161
|
+
/** Succeeded */
|
1095
1162
|
Succeeded = "Succeeded",
|
1163
|
+
/** Creating */
|
1096
1164
|
Creating = "Creating",
|
1165
|
+
/** Deleting */
|
1097
1166
|
Deleting = "Deleting",
|
1167
|
+
/** Failed */
|
1098
1168
|
Failed = "Failed"
|
1099
1169
|
}
|
1100
1170
|
|
@@ -1112,8 +1182,11 @@ export type PrivateEndpointConnectionProvisioningState = string;
|
|
1112
1182
|
|
1113
1183
|
/** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
|
1114
1184
|
export enum KnownPrivateEndpointServiceConnectionStatus {
|
1185
|
+
/** Pending */
|
1115
1186
|
Pending = "Pending",
|
1187
|
+
/** Approved */
|
1116
1188
|
Approved = "Approved",
|
1189
|
+
/** Rejected */
|
1117
1190
|
Rejected = "Rejected"
|
1118
1191
|
}
|
1119
1192
|
|
@@ -1130,7 +1203,9 @@ export type PrivateEndpointServiceConnectionStatus = string;
|
|
1130
1203
|
|
1131
1204
|
/** Known values of {@link StorageLimitExceededBehavior} that the service accepts. */
|
1132
1205
|
export enum KnownStorageLimitExceededBehavior {
|
1206
|
+
/** PurgeOldData */
|
1133
1207
|
PurgeOldData = "PurgeOldData",
|
1208
|
+
/** PauseIngress */
|
1134
1209
|
PauseIngress = "PauseIngress"
|
1135
1210
|
}
|
1136
1211
|
|
@@ -1146,6 +1221,7 @@ export type StorageLimitExceededBehavior = string;
|
|
1146
1221
|
|
1147
1222
|
/** Known values of {@link PropertyType} that the service accepts. */
|
1148
1223
|
export enum KnownPropertyType {
|
1224
|
+
/** String */
|
1149
1225
|
String = "String"
|
1150
1226
|
}
|
1151
1227
|
|
@@ -1160,7 +1236,9 @@ export type PropertyType = string;
|
|
1160
1236
|
|
1161
1237
|
/** Known values of {@link PublicNetworkAccess} that the service accepts. */
|
1162
1238
|
export enum KnownPublicNetworkAccess {
|
1239
|
+
/** Enabled */
|
1163
1240
|
Enabled = "enabled",
|
1241
|
+
/** Disabled */
|
1164
1242
|
Disabled = "disabled"
|
1165
1243
|
}
|
1166
1244
|
|
@@ -1176,10 +1254,15 @@ export type PublicNetworkAccess = string;
|
|
1176
1254
|
|
1177
1255
|
/** Known values of {@link IngressState} that the service accepts. */
|
1178
1256
|
export enum KnownIngressState {
|
1257
|
+
/** Disabled */
|
1179
1258
|
Disabled = "Disabled",
|
1259
|
+
/** Ready */
|
1180
1260
|
Ready = "Ready",
|
1261
|
+
/** Running */
|
1181
1262
|
Running = "Running",
|
1263
|
+
/** Paused */
|
1182
1264
|
Paused = "Paused",
|
1265
|
+
/** Unknown */
|
1183
1266
|
Unknown = "Unknown"
|
1184
1267
|
}
|
1185
1268
|
|
@@ -1198,8 +1281,11 @@ export type IngressState = string;
|
|
1198
1281
|
|
1199
1282
|
/** Known values of {@link WarmStoragePropertiesState} that the service accepts. */
|
1200
1283
|
export enum KnownWarmStoragePropertiesState {
|
1284
|
+
/** Ok */
|
1201
1285
|
Ok = "Ok",
|
1286
|
+
/** Error */
|
1202
1287
|
Error = "Error",
|
1288
|
+
/** Unknown */
|
1203
1289
|
Unknown = "Unknown"
|
1204
1290
|
}
|
1205
1291
|
|
@@ -1216,8 +1302,11 @@ export type WarmStoragePropertiesState = string;
|
|
1216
1302
|
|
1217
1303
|
/** Known values of {@link IngressStartAtType} that the service accepts. */
|
1218
1304
|
export enum KnownIngressStartAtType {
|
1305
|
+
/** EarliestAvailable */
|
1219
1306
|
EarliestAvailable = "EarliestAvailable",
|
1307
|
+
/** EventSourceCreationTime */
|
1220
1308
|
EventSourceCreationTime = "EventSourceCreationTime",
|
1309
|
+
/** CustomEnqueuedTime */
|
1221
1310
|
CustomEnqueuedTime = "CustomEnqueuedTime"
|
1222
1311
|
}
|
1223
1312
|
|