@azure/arm-timeseriesinsights 2.1.0-beta.1 → 2.1.0-beta.2
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 +38 -11
- package/README.md +1 -1
- 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 +15 -10
- 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/types/tsdoc-metadata.json +1 -1
@@ -108,14 +108,14 @@ export declare interface AccessPolicyListResponse {
|
|
108
108
|
}
|
109
109
|
|
110
110
|
/** 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. */
|
111
|
-
export declare
|
111
|
+
export declare interface AccessPolicyResource extends Resource {
|
112
112
|
/** The objectId of the principal in Azure Active Directory. */
|
113
113
|
principalObjectId?: string;
|
114
114
|
/** An description of the access policy. */
|
115
115
|
description?: string;
|
116
116
|
/** The list of roles the principal is assigned on the environment. */
|
117
117
|
roles?: AccessPolicyRole[];
|
118
|
-
}
|
118
|
+
}
|
119
119
|
|
120
120
|
/**
|
121
121
|
* Defines values for AccessPolicyRole. \
|
@@ -135,10 +135,10 @@ export declare interface AccessPolicyUpdateParameters {
|
|
135
135
|
}
|
136
136
|
|
137
137
|
/** Properties of an event source that reads events from an event broker in Azure. */
|
138
|
-
export declare
|
138
|
+
export declare interface AzureEventSourceProperties extends EventSourceCommonProperties {
|
139
139
|
/** The resource id of the event source in Azure Resource Manager. */
|
140
140
|
eventSourceResourceId: string;
|
141
|
-
}
|
141
|
+
}
|
142
142
|
|
143
143
|
/** Contains information about an API error. */
|
144
144
|
export declare interface CloudError {
|
@@ -187,12 +187,12 @@ export declare interface Dimension {
|
|
187
187
|
}
|
188
188
|
|
189
189
|
/** Parameters supplied to the CreateOrUpdate Environment operation. */
|
190
|
-
export declare
|
190
|
+
export declare interface EnvironmentCreateOrUpdateParameters extends CreateOrUpdateTrackedResourceProperties {
|
191
191
|
/** The kind of the environment. */
|
192
192
|
kind: EnvironmentKind;
|
193
193
|
/** 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. */
|
194
194
|
sku: Sku;
|
195
|
-
}
|
195
|
+
}
|
196
196
|
|
197
197
|
export declare type EnvironmentCreateOrUpdateParametersUnion = EnvironmentCreateOrUpdateParameters | Gen1EnvironmentCreateOrUpdateParameters | Gen2EnvironmentCreateOrUpdateParameters;
|
198
198
|
|
@@ -213,12 +213,12 @@ export declare interface EnvironmentListResponse {
|
|
213
213
|
}
|
214
214
|
|
215
215
|
/** An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. */
|
216
|
-
export declare
|
216
|
+
export declare interface EnvironmentResource extends TrackedResource {
|
217
217
|
/** 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. */
|
218
218
|
sku: Sku;
|
219
219
|
/** The kind of the environment. */
|
220
220
|
kind: EnvironmentResourceKind;
|
221
|
-
}
|
221
|
+
}
|
222
222
|
|
223
223
|
/**
|
224
224
|
* Defines values for EnvironmentResourceKind. \
|
@@ -231,7 +231,7 @@ export declare type EnvironmentResource = TrackedResource & {
|
|
231
231
|
export declare type EnvironmentResourceKind = string;
|
232
232
|
|
233
233
|
/** Properties of the environment. */
|
234
|
-
export declare
|
234
|
+
export declare interface EnvironmentResourceProperties extends ResourceProperties {
|
235
235
|
/**
|
236
236
|
* An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment.
|
237
237
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -247,7 +247,7 @@ export declare type EnvironmentResourceProperties = ResourceProperties & {
|
|
247
247
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
248
248
|
*/
|
249
249
|
readonly status?: EnvironmentStatus;
|
250
|
-
}
|
250
|
+
}
|
251
251
|
|
252
252
|
export declare type EnvironmentResourceUnion = EnvironmentResource | Gen1EnvironmentResource | Gen2EnvironmentResource;
|
253
253
|
|
@@ -403,7 +403,7 @@ export declare interface EnvironmentUpdateParameters {
|
|
403
403
|
export declare type EnvironmentUpdateParametersUnion = EnvironmentUpdateParameters | Gen1EnvironmentUpdateParameters | Gen2EnvironmentUpdateParameters;
|
404
404
|
|
405
405
|
/** Properties of the EventHub event source. */
|
406
|
-
export declare
|
406
|
+
export declare interface EventHubEventSourceCommonProperties extends AzureEventSourceProperties {
|
407
407
|
/** The name of the service bus that contains the event hub. */
|
408
408
|
serviceBusNamespace: string;
|
409
409
|
/** The name of the event hub. */
|
@@ -412,10 +412,12 @@ export declare type EventHubEventSourceCommonProperties = AzureEventSourceProper
|
|
412
412
|
consumerGroupName: string;
|
413
413
|
/** 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. */
|
414
414
|
keyName: string;
|
415
|
-
}
|
415
|
+
}
|
416
416
|
|
417
417
|
/** Parameters supplied to the Create or Update Event Source operation for an EventHub event source. */
|
418
|
-
export declare
|
418
|
+
export declare interface EventHubEventSourceCreateOrUpdateParameters extends EventSourceCreateOrUpdateParameters {
|
419
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
420
|
+
kind: "Microsoft.EventHub";
|
419
421
|
/**
|
420
422
|
* Provisioning state of the resource.
|
421
423
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -446,22 +448,24 @@ export declare type EventHubEventSourceCreateOrUpdateParameters = EventSourceCre
|
|
446
448
|
keyName: string;
|
447
449
|
/** 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. */
|
448
450
|
sharedAccessKey: string;
|
449
|
-
}
|
451
|
+
}
|
450
452
|
|
451
453
|
/** Properties of the EventHub event source that are required on create or update requests. */
|
452
|
-
export declare
|
454
|
+
export declare interface EventHubEventSourceCreationProperties extends EventHubEventSourceCommonProperties {
|
453
455
|
/** 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. */
|
454
456
|
sharedAccessKey: string;
|
455
|
-
}
|
457
|
+
}
|
456
458
|
|
457
459
|
/** An object that represents a set of mutable EventHub event source resource properties. */
|
458
|
-
export declare
|
460
|
+
export declare interface EventHubEventSourceMutableProperties extends EventSourceMutableProperties {
|
459
461
|
/** 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. */
|
460
462
|
sharedAccessKey?: string;
|
461
|
-
}
|
463
|
+
}
|
462
464
|
|
463
465
|
/** An event source that receives its data from an Azure EventHub. */
|
464
|
-
export declare
|
466
|
+
export declare interface EventHubEventSourceResource extends EventSourceResource {
|
467
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
468
|
+
kind: "Microsoft.EventHub";
|
465
469
|
/**
|
466
470
|
* Provisioning state of the resource.
|
467
471
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -490,23 +494,24 @@ export declare type EventHubEventSourceResource = EventSourceResource & {
|
|
490
494
|
consumerGroupName: string;
|
491
495
|
/** 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. */
|
492
496
|
keyName: string;
|
493
|
-
}
|
497
|
+
}
|
494
498
|
|
495
499
|
/** Properties of the EventHub event source resource. */
|
496
|
-
export declare
|
500
|
+
export declare interface EventHubEventSourceResourceProperties extends EventHubEventSourceCommonProperties {
|
501
|
+
}
|
497
502
|
|
498
503
|
/** Parameters supplied to the Update Event Source operation to update an EventHub event source. */
|
499
|
-
export declare
|
504
|
+
export declare interface EventHubEventSourceUpdateParameters extends EventSourceUpdateParameters {
|
500
505
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
501
506
|
kind: "Microsoft.EventHub";
|
502
507
|
/** 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. */
|
503
508
|
timestampPropertyName?: string;
|
504
509
|
/** 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. */
|
505
510
|
sharedAccessKey?: string;
|
506
|
-
}
|
511
|
+
}
|
507
512
|
|
508
513
|
/** Properties of the event source. */
|
509
|
-
export declare
|
514
|
+
export declare interface EventSourceCommonProperties extends ResourceProperties {
|
510
515
|
/** 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. */
|
511
516
|
timestampPropertyName?: string;
|
512
517
|
/** 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. */
|
@@ -515,15 +520,15 @@ export declare type EventSourceCommonProperties = ResourceProperties & {
|
|
515
520
|
type?: IngressStartAtType;
|
516
521
|
/** 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. */
|
517
522
|
time?: string;
|
518
|
-
}
|
523
|
+
}
|
519
524
|
|
520
525
|
/** Parameters supplied to the Create or Update Event Source operation. */
|
521
|
-
export declare
|
526
|
+
export declare interface EventSourceCreateOrUpdateParameters extends CreateOrUpdateTrackedResourceProperties {
|
522
527
|
/** The kind of the event source. */
|
523
528
|
kind: EventSourceKind;
|
524
529
|
/** 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. */
|
525
530
|
localTimestamp?: LocalTimestamp;
|
526
|
-
}
|
531
|
+
}
|
527
532
|
|
528
533
|
export declare type EventSourceCreateOrUpdateParametersUnion = EventSourceCreateOrUpdateParameters | EventHubEventSourceCreateOrUpdateParameters | IoTHubEventSourceCreateOrUpdateParameters;
|
529
534
|
|
@@ -550,10 +555,10 @@ export declare interface EventSourceMutableProperties {
|
|
550
555
|
}
|
551
556
|
|
552
557
|
/** 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 */
|
553
|
-
export declare
|
558
|
+
export declare interface EventSourceResource extends TrackedResource {
|
554
559
|
/** The kind of the event source. */
|
555
560
|
kind: EventSourceResourceKind;
|
556
|
-
}
|
561
|
+
}
|
557
562
|
|
558
563
|
/**
|
559
564
|
* Defines values for EventSourceResourceKind. \
|
@@ -669,14 +674,16 @@ export declare interface EventSourceUpdateParameters {
|
|
669
674
|
export declare type EventSourceUpdateParametersUnion = EventSourceUpdateParameters | EventHubEventSourceUpdateParameters | IoTHubEventSourceUpdateParameters;
|
670
675
|
|
671
676
|
/** Parameters supplied to the Create or Update Environment operation for a Gen1 environment. */
|
672
|
-
export declare
|
677
|
+
export declare interface Gen1EnvironmentCreateOrUpdateParameters extends EnvironmentCreateOrUpdateParameters {
|
678
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
679
|
+
kind: "Gen1";
|
673
680
|
/** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
|
674
681
|
dataRetentionTime: string;
|
675
682
|
/** 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. */
|
676
683
|
storageLimitExceededBehavior?: StorageLimitExceededBehavior;
|
677
684
|
/** The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported. */
|
678
685
|
partitionKeyProperties?: TimeSeriesIdProperty[];
|
679
|
-
}
|
686
|
+
}
|
680
687
|
|
681
688
|
/** Properties used to create a Gen1 environment. */
|
682
689
|
export declare interface Gen1EnvironmentCreationProperties {
|
@@ -689,7 +696,9 @@ export declare interface Gen1EnvironmentCreationProperties {
|
|
689
696
|
}
|
690
697
|
|
691
698
|
/** 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. */
|
692
|
-
export declare
|
699
|
+
export declare interface Gen1EnvironmentResource extends EnvironmentResource {
|
700
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
701
|
+
kind: "Gen1";
|
693
702
|
/** ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. */
|
694
703
|
dataRetentionTime: string;
|
695
704
|
/** 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. */
|
@@ -721,13 +730,14 @@ export declare type Gen1EnvironmentResource = EnvironmentResource & {
|
|
721
730
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
722
731
|
*/
|
723
732
|
readonly status?: EnvironmentStatus;
|
724
|
-
}
|
733
|
+
}
|
725
734
|
|
726
735
|
/** Properties of the Gen1 environment. */
|
727
|
-
export declare
|
736
|
+
export declare interface Gen1EnvironmentResourceProperties extends Gen1EnvironmentCreationProperties, EnvironmentResourceProperties {
|
737
|
+
}
|
728
738
|
|
729
739
|
/** Parameters supplied to the Update Environment operation to update a Gen1 environment. */
|
730
|
-
export declare
|
740
|
+
export declare interface Gen1EnvironmentUpdateParameters extends EnvironmentUpdateParameters {
|
731
741
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
732
742
|
kind: "Gen1";
|
733
743
|
/** The sku of the environment. */
|
@@ -736,10 +746,12 @@ export declare type Gen1EnvironmentUpdateParameters = EnvironmentUpdateParameter
|
|
736
746
|
dataRetentionTime?: string;
|
737
747
|
/** 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. */
|
738
748
|
storageLimitExceededBehavior?: StorageLimitExceededBehavior;
|
739
|
-
}
|
749
|
+
}
|
740
750
|
|
741
751
|
/** Parameters supplied to the Create or Update Environment operation for a Gen2 environment. */
|
742
|
-
export declare
|
752
|
+
export declare interface Gen2EnvironmentCreateOrUpdateParameters extends EnvironmentCreateOrUpdateParameters {
|
753
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
754
|
+
kind: "Gen2";
|
743
755
|
/** The list of event properties which will be used to define the environment's time series id. */
|
744
756
|
timeSeriesIdProperties: TimeSeriesIdProperty[];
|
745
757
|
/** 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. */
|
@@ -753,10 +765,12 @@ export declare type Gen2EnvironmentCreateOrUpdateParameters = EnvironmentCreateO
|
|
753
765
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
754
766
|
*/
|
755
767
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
756
|
-
}
|
768
|
+
}
|
757
769
|
|
758
770
|
/** 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. */
|
759
|
-
export declare
|
771
|
+
export declare interface Gen2EnvironmentResource extends EnvironmentResource {
|
772
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
773
|
+
kind: "Gen2";
|
760
774
|
/**
|
761
775
|
* Provisioning state of the resource.
|
762
776
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -795,10 +809,10 @@ export declare type Gen2EnvironmentResource = EnvironmentResource & {
|
|
795
809
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
796
810
|
*/
|
797
811
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
798
|
-
}
|
812
|
+
}
|
799
813
|
|
800
814
|
/** Properties of the Gen2 environment. */
|
801
|
-
export declare
|
815
|
+
export declare interface Gen2EnvironmentResourceProperties extends EnvironmentResourceProperties {
|
802
816
|
/** The list of event properties which will be used to define the environment's time series id. */
|
803
817
|
timeSeriesIdProperties: TimeSeriesIdProperty[];
|
804
818
|
/** 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. */
|
@@ -812,17 +826,17 @@ export declare type Gen2EnvironmentResourceProperties = EnvironmentResourcePrope
|
|
812
826
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
813
827
|
*/
|
814
828
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
815
|
-
}
|
829
|
+
}
|
816
830
|
|
817
831
|
/** Parameters supplied to the Update Environment operation to update a Gen2 environment. */
|
818
|
-
export declare
|
832
|
+
export declare interface Gen2EnvironmentUpdateParameters extends EnvironmentUpdateParameters {
|
819
833
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
820
834
|
kind: "Gen2";
|
821
835
|
/** 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. */
|
822
836
|
storageConfiguration?: Gen2StorageConfigurationMutableProperties;
|
823
837
|
/** 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. */
|
824
838
|
warmStoreConfiguration?: WarmStoreConfigurationProperties;
|
825
|
-
}
|
839
|
+
}
|
826
840
|
|
827
841
|
/** 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. */
|
828
842
|
export declare interface Gen2StorageConfigurationInput {
|
@@ -844,6 +858,15 @@ export declare interface Gen2StorageConfigurationOutput {
|
|
844
858
|
accountName: string;
|
845
859
|
}
|
846
860
|
|
861
|
+
/**
|
862
|
+
* Given the last `.value` produced by the `byPage` iterator,
|
863
|
+
* returns a continuation token that can be used to begin paging from
|
864
|
+
* that point later.
|
865
|
+
* @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
|
866
|
+
* @returns The continuation token that can be passed into byPage() during future calls.
|
867
|
+
*/
|
868
|
+
export declare function getContinuationToken(page: unknown): string | undefined;
|
869
|
+
|
847
870
|
/** An object that represents the status of ingress on an environment. */
|
848
871
|
export declare interface IngressEnvironmentStatus {
|
849
872
|
/** This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown" */
|
@@ -880,17 +903,19 @@ export declare type IngressStartAtType = string;
|
|
880
903
|
export declare type IngressState = string;
|
881
904
|
|
882
905
|
/** Properties of the IoTHub event source. */
|
883
|
-
export declare
|
906
|
+
export declare interface IoTHubEventSourceCommonProperties extends AzureEventSourceProperties {
|
884
907
|
/** The name of the iot hub. */
|
885
908
|
iotHubName: string;
|
886
909
|
/** The name of the iot hub's consumer group that holds the partitions from which events will be read. */
|
887
910
|
consumerGroupName: string;
|
888
911
|
/** 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. */
|
889
912
|
keyName: string;
|
890
|
-
}
|
913
|
+
}
|
891
914
|
|
892
915
|
/** Parameters supplied to the Create or Update Event Source operation for an IoTHub event source. */
|
893
|
-
export declare
|
916
|
+
export declare interface IoTHubEventSourceCreateOrUpdateParameters extends EventSourceCreateOrUpdateParameters {
|
917
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
918
|
+
kind: "Microsoft.IoTHub";
|
894
919
|
/**
|
895
920
|
* Provisioning state of the resource.
|
896
921
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -919,22 +944,24 @@ export declare type IoTHubEventSourceCreateOrUpdateParameters = EventSourceCreat
|
|
919
944
|
keyName: string;
|
920
945
|
/** 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. */
|
921
946
|
sharedAccessKey: string;
|
922
|
-
}
|
947
|
+
}
|
923
948
|
|
924
949
|
/** Properties of the IoTHub event source that are required on create or update requests. */
|
925
|
-
export declare
|
950
|
+
export declare interface IoTHubEventSourceCreationProperties extends IoTHubEventSourceCommonProperties {
|
926
951
|
/** 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. */
|
927
952
|
sharedAccessKey: string;
|
928
|
-
}
|
953
|
+
}
|
929
954
|
|
930
955
|
/** An object that represents a set of mutable IoTHub event source resource properties. */
|
931
|
-
export declare
|
956
|
+
export declare interface IoTHubEventSourceMutableProperties extends EventSourceMutableProperties {
|
932
957
|
/** 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. */
|
933
958
|
sharedAccessKey?: string;
|
934
|
-
}
|
959
|
+
}
|
935
960
|
|
936
961
|
/** An event source that receives its data from an Azure IoTHub. */
|
937
|
-
export declare
|
962
|
+
export declare interface IoTHubEventSourceResource extends EventSourceResource {
|
963
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
964
|
+
kind: "Microsoft.IoTHub";
|
938
965
|
/**
|
939
966
|
* Provisioning state of the resource.
|
940
967
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -961,140 +988,191 @@ export declare type IoTHubEventSourceResource = EventSourceResource & {
|
|
961
988
|
consumerGroupName: string;
|
962
989
|
/** 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. */
|
963
990
|
keyName: string;
|
964
|
-
}
|
991
|
+
}
|
965
992
|
|
966
993
|
/** Properties of the IoTHub event source resource. */
|
967
|
-
export declare
|
994
|
+
export declare interface IoTHubEventSourceResourceProperties extends IoTHubEventSourceCommonProperties {
|
995
|
+
}
|
968
996
|
|
969
997
|
/** Parameters supplied to the Update Event Source operation to update an IoTHub event source. */
|
970
|
-
export declare
|
998
|
+
export declare interface IoTHubEventSourceUpdateParameters extends EventSourceUpdateParameters {
|
971
999
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
972
1000
|
kind: "Microsoft.IoTHub";
|
973
1001
|
/** 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. */
|
974
1002
|
timestampPropertyName?: string;
|
975
1003
|
/** 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. */
|
976
1004
|
sharedAccessKey?: string;
|
977
|
-
}
|
1005
|
+
}
|
978
1006
|
|
979
1007
|
/** Known values of {@link AccessPolicyRole} that the service accepts. */
|
980
1008
|
export declare enum KnownAccessPolicyRole {
|
1009
|
+
/** Reader */
|
981
1010
|
Reader = "Reader",
|
1011
|
+
/** Contributor */
|
982
1012
|
Contributor = "Contributor"
|
983
1013
|
}
|
984
1014
|
|
985
1015
|
/** Known values of {@link DataStringComparisonBehavior} that the service accepts. */
|
986
1016
|
export declare enum KnownDataStringComparisonBehavior {
|
1017
|
+
/** Ordinal */
|
987
1018
|
Ordinal = "Ordinal",
|
1019
|
+
/** OrdinalIgnoreCase */
|
988
1020
|
OrdinalIgnoreCase = "OrdinalIgnoreCase"
|
989
1021
|
}
|
990
1022
|
|
991
1023
|
/** Known values of {@link EnvironmentKind} that the service accepts. */
|
992
1024
|
export declare enum KnownEnvironmentKind {
|
1025
|
+
/** Gen1 */
|
993
1026
|
Gen1 = "Gen1",
|
1027
|
+
/** Gen2 */
|
994
1028
|
Gen2 = "Gen2"
|
995
1029
|
}
|
996
1030
|
|
997
1031
|
/** Known values of {@link EnvironmentResourceKind} that the service accepts. */
|
998
1032
|
export declare enum KnownEnvironmentResourceKind {
|
1033
|
+
/** Gen1 */
|
999
1034
|
Gen1 = "Gen1",
|
1035
|
+
/** Gen2 */
|
1000
1036
|
Gen2 = "Gen2"
|
1001
1037
|
}
|
1002
1038
|
|
1003
1039
|
/** Known values of {@link EventSourceKind} that the service accepts. */
|
1004
1040
|
export declare enum KnownEventSourceKind {
|
1041
|
+
/** MicrosoftEventHub */
|
1005
1042
|
MicrosoftEventHub = "Microsoft.EventHub",
|
1043
|
+
/** MicrosoftIoTHub */
|
1006
1044
|
MicrosoftIoTHub = "Microsoft.IoTHub"
|
1007
1045
|
}
|
1008
1046
|
|
1009
1047
|
/** Known values of {@link EventSourceResourceKind} that the service accepts. */
|
1010
1048
|
export declare enum KnownEventSourceResourceKind {
|
1049
|
+
/** MicrosoftEventHub */
|
1011
1050
|
MicrosoftEventHub = "Microsoft.EventHub",
|
1051
|
+
/** MicrosoftIoTHub */
|
1012
1052
|
MicrosoftIoTHub = "Microsoft.IoTHub"
|
1013
1053
|
}
|
1014
1054
|
|
1015
1055
|
/** Known values of {@link IngressStartAtType} that the service accepts. */
|
1016
1056
|
export declare enum KnownIngressStartAtType {
|
1057
|
+
/** EarliestAvailable */
|
1017
1058
|
EarliestAvailable = "EarliestAvailable",
|
1059
|
+
/** EventSourceCreationTime */
|
1018
1060
|
EventSourceCreationTime = "EventSourceCreationTime",
|
1061
|
+
/** CustomEnqueuedTime */
|
1019
1062
|
CustomEnqueuedTime = "CustomEnqueuedTime"
|
1020
1063
|
}
|
1021
1064
|
|
1022
1065
|
/** Known values of {@link IngressState} that the service accepts. */
|
1023
1066
|
export declare enum KnownIngressState {
|
1067
|
+
/** Disabled */
|
1024
1068
|
Disabled = "Disabled",
|
1069
|
+
/** Ready */
|
1025
1070
|
Ready = "Ready",
|
1071
|
+
/** Running */
|
1026
1072
|
Running = "Running",
|
1073
|
+
/** Paused */
|
1027
1074
|
Paused = "Paused",
|
1075
|
+
/** Unknown */
|
1028
1076
|
Unknown = "Unknown"
|
1029
1077
|
}
|
1030
1078
|
|
1031
1079
|
/** Known values of {@link LocalTimestampFormat} that the service accepts. */
|
1032
1080
|
export declare enum KnownLocalTimestampFormat {
|
1081
|
+
/** Embedded */
|
1033
1082
|
Embedded = "Embedded"
|
1034
1083
|
}
|
1035
1084
|
|
1036
1085
|
/** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
|
1037
1086
|
export declare enum KnownPrivateEndpointConnectionProvisioningState {
|
1087
|
+
/** Succeeded */
|
1038
1088
|
Succeeded = "Succeeded",
|
1089
|
+
/** Creating */
|
1039
1090
|
Creating = "Creating",
|
1091
|
+
/** Deleting */
|
1040
1092
|
Deleting = "Deleting",
|
1093
|
+
/** Failed */
|
1041
1094
|
Failed = "Failed"
|
1042
1095
|
}
|
1043
1096
|
|
1044
1097
|
/** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
|
1045
1098
|
export declare enum KnownPrivateEndpointServiceConnectionStatus {
|
1099
|
+
/** Pending */
|
1046
1100
|
Pending = "Pending",
|
1101
|
+
/** Approved */
|
1047
1102
|
Approved = "Approved",
|
1103
|
+
/** Rejected */
|
1048
1104
|
Rejected = "Rejected"
|
1049
1105
|
}
|
1050
1106
|
|
1051
1107
|
/** Known values of {@link PropertyType} that the service accepts. */
|
1052
1108
|
export declare enum KnownPropertyType {
|
1109
|
+
/** String */
|
1053
1110
|
String = "String"
|
1054
1111
|
}
|
1055
1112
|
|
1056
1113
|
/** Known values of {@link ProvisioningState} that the service accepts. */
|
1057
1114
|
export declare enum KnownProvisioningState {
|
1115
|
+
/** Accepted */
|
1058
1116
|
Accepted = "Accepted",
|
1117
|
+
/** Creating */
|
1059
1118
|
Creating = "Creating",
|
1119
|
+
/** Updating */
|
1060
1120
|
Updating = "Updating",
|
1121
|
+
/** Succeeded */
|
1061
1122
|
Succeeded = "Succeeded",
|
1123
|
+
/** Failed */
|
1062
1124
|
Failed = "Failed",
|
1125
|
+
/** Deleting */
|
1063
1126
|
Deleting = "Deleting"
|
1064
1127
|
}
|
1065
1128
|
|
1066
1129
|
/** Known values of {@link PublicNetworkAccess} that the service accepts. */
|
1067
1130
|
export declare enum KnownPublicNetworkAccess {
|
1131
|
+
/** Enabled */
|
1068
1132
|
Enabled = "enabled",
|
1133
|
+
/** Disabled */
|
1069
1134
|
Disabled = "disabled"
|
1070
1135
|
}
|
1071
1136
|
|
1072
1137
|
/** Known values of {@link ReferenceDataKeyPropertyType} that the service accepts. */
|
1073
1138
|
export declare enum KnownReferenceDataKeyPropertyType {
|
1139
|
+
/** String */
|
1074
1140
|
String = "String",
|
1141
|
+
/** Double */
|
1075
1142
|
Double = "Double",
|
1143
|
+
/** Bool */
|
1076
1144
|
Bool = "Bool",
|
1145
|
+
/** DateTime */
|
1077
1146
|
DateTime = "DateTime"
|
1078
1147
|
}
|
1079
1148
|
|
1080
1149
|
/** Known values of {@link SkuName} that the service accepts. */
|
1081
1150
|
export declare enum KnownSkuName {
|
1151
|
+
/** S1 */
|
1082
1152
|
S1 = "S1",
|
1153
|
+
/** S2 */
|
1083
1154
|
S2 = "S2",
|
1155
|
+
/** P1 */
|
1084
1156
|
P1 = "P1",
|
1157
|
+
/** L1 */
|
1085
1158
|
L1 = "L1"
|
1086
1159
|
}
|
1087
1160
|
|
1088
1161
|
/** Known values of {@link StorageLimitExceededBehavior} that the service accepts. */
|
1089
1162
|
export declare enum KnownStorageLimitExceededBehavior {
|
1163
|
+
/** PurgeOldData */
|
1090
1164
|
PurgeOldData = "PurgeOldData",
|
1165
|
+
/** PauseIngress */
|
1091
1166
|
PauseIngress = "PauseIngress"
|
1092
1167
|
}
|
1093
1168
|
|
1094
1169
|
/** Known values of {@link WarmStoragePropertiesState} that the service accepts. */
|
1095
1170
|
export declare enum KnownWarmStoragePropertiesState {
|
1171
|
+
/** Ok */
|
1096
1172
|
Ok = "Ok",
|
1173
|
+
/** Error */
|
1097
1174
|
Error = "Error",
|
1175
|
+
/** Unknown */
|
1098
1176
|
Unknown = "Unknown"
|
1099
1177
|
}
|
1100
1178
|
|
@@ -1246,7 +1324,7 @@ export declare interface PrivateEndpoint {
|
|
1246
1324
|
}
|
1247
1325
|
|
1248
1326
|
/** The Private Endpoint Connection resource. */
|
1249
|
-
export declare
|
1327
|
+
export declare interface PrivateEndpointConnection extends Resource {
|
1250
1328
|
/**
|
1251
1329
|
* Provisioning state of the private endpoint connection.
|
1252
1330
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -1258,7 +1336,7 @@ export declare type PrivateEndpointConnection = Resource & {
|
|
1258
1336
|
groupIds?: string[];
|
1259
1337
|
/** A collection of information about the state of the connection between service consumer and provider. */
|
1260
1338
|
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
|
1261
|
-
}
|
1339
|
+
}
|
1262
1340
|
|
1263
1341
|
/** List of private endpoint connection associated with the specified storage account */
|
1264
1342
|
export declare interface PrivateEndpointConnectionListResult {
|
@@ -1358,7 +1436,7 @@ export declare type PrivateEndpointConnectionsListByEnvironmentResponse = Privat
|
|
1358
1436
|
export declare type PrivateEndpointServiceConnectionStatus = string;
|
1359
1437
|
|
1360
1438
|
/** A private link resource */
|
1361
|
-
export declare
|
1439
|
+
export declare interface PrivateLinkResource extends Resource {
|
1362
1440
|
/**
|
1363
1441
|
* The private link resource group id.
|
1364
1442
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
@@ -1371,7 +1449,7 @@ export declare type PrivateLinkResource = Resource & {
|
|
1371
1449
|
readonly requiredMembers?: string[];
|
1372
1450
|
/** The private link resource Private link DNS zone name. */
|
1373
1451
|
requiredZoneNames?: string[];
|
1374
|
-
}
|
1452
|
+
}
|
1375
1453
|
|
1376
1454
|
/** A list of private link resources */
|
1377
1455
|
export declare interface PrivateLinkResourceListResult {
|
@@ -1453,12 +1531,12 @@ export declare type PublicNetworkAccess = string;
|
|
1453
1531
|
*/
|
1454
1532
|
export declare type ReferenceDataKeyPropertyType = string;
|
1455
1533
|
|
1456
|
-
export declare
|
1534
|
+
export declare interface ReferenceDataSetCreateOrUpdateParameters extends CreateOrUpdateTrackedResourceProperties {
|
1457
1535
|
/** The list of key properties for the reference data set. */
|
1458
1536
|
keyProperties: ReferenceDataSetKeyProperty[];
|
1459
1537
|
/** 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. */
|
1460
1538
|
dataStringComparisonBehavior?: DataStringComparisonBehavior;
|
1461
|
-
}
|
1539
|
+
}
|
1462
1540
|
|
1463
1541
|
/** Properties used to create a reference data set. */
|
1464
1542
|
export declare interface ReferenceDataSetCreationProperties {
|
@@ -1483,7 +1561,7 @@ export declare interface ReferenceDataSetListResponse {
|
|
1483
1561
|
}
|
1484
1562
|
|
1485
1563
|
/** 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. */
|
1486
|
-
export declare
|
1564
|
+
export declare interface ReferenceDataSetResource extends TrackedResource {
|
1487
1565
|
/** The list of key properties for the reference data set. */
|
1488
1566
|
keyProperties?: ReferenceDataSetKeyProperty[];
|
1489
1567
|
/** 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. */
|
@@ -1498,10 +1576,11 @@ export declare type ReferenceDataSetResource = TrackedResource & {
|
|
1498
1576
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
1499
1577
|
*/
|
1500
1578
|
readonly creationTime?: Date;
|
1501
|
-
}
|
1579
|
+
}
|
1502
1580
|
|
1503
1581
|
/** Properties of the reference data set. */
|
1504
|
-
export declare
|
1582
|
+
export declare interface ReferenceDataSetResourceProperties extends ReferenceDataSetCreationProperties, ResourceProperties {
|
1583
|
+
}
|
1505
1584
|
|
1506
1585
|
/** Interface representing a ReferenceDataSets. */
|
1507
1586
|
export declare interface ReferenceDataSets {
|
@@ -1690,6 +1769,8 @@ export declare class TimeSeriesInsightsClient extends coreClient.ServiceClient {
|
|
1690
1769
|
* @param options The parameter options
|
1691
1770
|
*/
|
1692
1771
|
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: TimeSeriesInsightsClientOptionalParams);
|
1772
|
+
/** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
|
1773
|
+
private addCustomApiVersionPolicy;
|
1693
1774
|
operations: Operations;
|
1694
1775
|
environments: Environments;
|
1695
1776
|
eventSources: EventSources;
|
@@ -1710,14 +1791,14 @@ export declare interface TimeSeriesInsightsClientOptionalParams extends coreClie
|
|
1710
1791
|
}
|
1711
1792
|
|
1712
1793
|
/** Time Series Insights resource that is tracked by Azure Resource Manager. */
|
1713
|
-
export declare
|
1794
|
+
export declare interface TrackedResource extends Resource {
|
1714
1795
|
/** Resource location */
|
1715
1796
|
location: string;
|
1716
1797
|
/** Resource tags */
|
1717
1798
|
tags?: {
|
1718
1799
|
[propertyName: string]: string;
|
1719
1800
|
};
|
1720
|
-
}
|
1801
|
+
}
|
1721
1802
|
|
1722
1803
|
/** An object that represents the status of warm storage on an environment. */
|
1723
1804
|
export declare interface WarmStorageEnvironmentStatus {
|