@azure/arm-timeseriesinsights package

Classes

TimeSeriesInsightsClient

Interfaces

AccessPolicies	Interface representing a AccessPolicies.
AccessPoliciesCreateOrUpdateOptionalParams	Optional parameters.
AccessPoliciesDeleteOptionalParams	Optional parameters.
AccessPoliciesGetOptionalParams	Optional parameters.
AccessPoliciesListByEnvironmentOptionalParams	Optional parameters.
AccessPoliciesUpdateOptionalParams	Optional parameters.
AccessPolicyCreateOrUpdateParameters
AccessPolicyListResponse	The response of the List access policies operation.
AccessPolicyResource	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.
AccessPolicyUpdateParameters
AzureEventSourceProperties	Properties of an event source that reads events from an event broker in Azure.
CloudError	Contains information about an API error.
CloudErrorBody	Describes a particular API error with an error code and a message.
CreateOrUpdateTrackedResourceProperties	Properties required to create any resource tracked by Azure Resource Manager.
Dimension	Dimension of blobs, possibly be blob type or access tier.
EnvironmentCreateOrUpdateParameters	Parameters supplied to the CreateOrUpdate Environment operation.
EnvironmentListResponse	The response of the List Environments operation.
EnvironmentResource	An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource.
EnvironmentResourceProperties	Properties of the environment.
EnvironmentStateDetails	An object that contains the details about an environment's state.
EnvironmentStatus	An object that represents the status of the environment, and its internal state in the Time Series Insights service.
EnvironmentUpdateParameters	Parameters supplied to the Update Environment operation.
Environments	Interface representing a Environments.
EnvironmentsCreateOrUpdateOptionalParams	Optional parameters.
EnvironmentsDeleteOptionalParams	Optional parameters.
EnvironmentsGetOptionalParams	Optional parameters.
EnvironmentsListByResourceGroupOptionalParams	Optional parameters.
EnvironmentsListBySubscriptionOptionalParams	Optional parameters.
EnvironmentsUpdateOptionalParams	Optional parameters.
EventHubEventSourceCommonProperties	Properties of the EventHub event source.
EventHubEventSourceCreateOrUpdateParameters	Parameters supplied to the Create or Update Event Source operation for an EventHub event source.
EventHubEventSourceCreationProperties	Properties of the EventHub event source that are required on create or update requests.
EventHubEventSourceMutableProperties	An object that represents a set of mutable EventHub event source resource properties.
EventHubEventSourceResource	An event source that receives its data from an Azure EventHub.
EventHubEventSourceResourceProperties	Properties of the EventHub event source resource.
EventHubEventSourceUpdateParameters	Parameters supplied to the Update Event Source operation to update an EventHub event source.
EventSourceCommonProperties	Properties of the event source.
EventSourceCreateOrUpdateParameters	Parameters supplied to the Create or Update Event Source operation.
EventSourceListResponse	The response of the List EventSources operation.
EventSourceMutableProperties	An object that represents a set of mutable event source resource properties.
EventSourceResource	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
EventSourceUpdateParameters	Parameters supplied to the Update Event Source operation.
EventSources	Interface representing a EventSources.
EventSourcesCreateOrUpdateOptionalParams	Optional parameters.
EventSourcesDeleteOptionalParams	Optional parameters.
EventSourcesGetOptionalParams	Optional parameters.
EventSourcesListByEnvironmentOptionalParams	Optional parameters.
EventSourcesUpdateOptionalParams	Optional parameters.
Gen1EnvironmentCreateOrUpdateParameters	Parameters supplied to the Create or Update Environment operation for a Gen1 environment.
Gen1EnvironmentCreationProperties	Properties used to create a Gen1 environment.
Gen1EnvironmentResource	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.
Gen1EnvironmentResourceProperties	Properties of the Gen1 environment.
Gen1EnvironmentUpdateParameters	Parameters supplied to the Update Environment operation to update a Gen1 environment.
Gen2EnvironmentCreateOrUpdateParameters	Parameters supplied to the Create or Update Environment operation for a Gen2 environment.
Gen2EnvironmentResource	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.
Gen2EnvironmentResourceProperties	Properties of the Gen2 environment.
Gen2EnvironmentUpdateParameters	Parameters supplied to the Update Environment operation to update a Gen2 environment.
Gen2StorageConfigurationInput	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.
Gen2StorageConfigurationMutableProperties	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.
Gen2StorageConfigurationOutput	The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data.
IngressEnvironmentStatus	An object that represents the status of ingress on an environment.
IoTHubEventSourceCommonProperties	Properties of the IoTHub event source.
IoTHubEventSourceCreateOrUpdateParameters	Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.
IoTHubEventSourceCreationProperties	Properties of the IoTHub event source that are required on create or update requests.
IoTHubEventSourceMutableProperties	An object that represents a set of mutable IoTHub event source resource properties.
IoTHubEventSourceResource	An event source that receives its data from an Azure IoTHub.
IoTHubEventSourceResourceProperties	Properties of the IoTHub event source resource.
IoTHubEventSourceUpdateParameters	Parameters supplied to the Update Event Source operation to update an IoTHub event source.
LocalTimestamp	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.
LocalTimestampTimeZoneOffset	An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.
LogSpecification	The specification of an Azure Monitoring log.
MetricAvailability	Retention policy of a resource metric.
MetricSpecification	Metric specification of operation.
Operation	A Time Series Insights REST API operation
OperationDisplay	Contains the localized display information for this particular operation / action.
OperationListResult	Result of the request to list Time Series Insights operations. It contains a list of operations and a URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionListResult	List of private endpoint connection associated with the specified storage account
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByEnvironmentOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesListSupportedOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ReferenceDataSetCreateOrUpdateParameters	Properties required to create any resource tracked by Azure Resource Manager.
ReferenceDataSetCreationProperties	Properties used to create a reference data set.
ReferenceDataSetKeyProperty	A key property for the reference data set. A reference data set can have multiple key properties.
ReferenceDataSetListResponse	The response of the List Reference Data Sets operation.
ReferenceDataSetResource	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.
ReferenceDataSetResourceProperties	Properties of the reference data set.
ReferenceDataSetUpdateParameters	Parameters supplied to the Update Reference Data Set operation.
ReferenceDataSets	Interface representing a ReferenceDataSets.
ReferenceDataSetsCreateOrUpdateOptionalParams	Optional parameters.
ReferenceDataSetsDeleteOptionalParams	Optional parameters.
ReferenceDataSetsGetOptionalParams	Optional parameters.
ReferenceDataSetsListByEnvironmentOptionalParams	Optional parameters.
ReferenceDataSetsUpdateOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceProperties	Properties that are common to all tracked resources.
ServiceSpecification	One property of operation, include metric specifications.
Sku	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.
TimeSeriesIdProperty	The structure of the property that a time series id can have. An environment can have multiple such properties.
TimeSeriesInsightsClientOptionalParams	Optional parameters.
TrackedResource	Time Series Insights resource that is tracked by Azure Resource Manager.
WarmStorageEnvironmentStatus	An object that represents the status of warm storage on an environment.
WarmStoreConfigurationProperties	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.

Type Aliases

AccessPoliciesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AccessPoliciesGetResponse	Contains response data for the get operation.
AccessPoliciesListByEnvironmentResponse	Contains response data for the listByEnvironment operation.
AccessPoliciesUpdateResponse	Contains response data for the update operation.
AccessPolicyRole	Defines values for AccessPolicyRole. KnownAccessPolicyRole can be used interchangeably with AccessPolicyRole, this enum contains the known values that the service supports. Known values supported by the service Reader Contributor
DataStringComparisonBehavior	Defines values for DataStringComparisonBehavior. KnownDataStringComparisonBehavior can be used interchangeably with DataStringComparisonBehavior, this enum contains the known values that the service supports. Known values supported by the service Ordinal OrdinalIgnoreCase
EnvironmentCreateOrUpdateParametersUnion
EnvironmentKind	Defines values for EnvironmentKind. KnownEnvironmentKind can be used interchangeably with EnvironmentKind, this enum contains the known values that the service supports. Known values supported by the service Gen1 Gen2
EnvironmentResourceKind	Defines values for EnvironmentResourceKind. KnownEnvironmentResourceKind can be used interchangeably with EnvironmentResourceKind, this enum contains the known values that the service supports. Known values supported by the service Gen1 Gen2
EnvironmentResourceUnion
EnvironmentUpdateParametersUnion
EnvironmentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
EnvironmentsGetResponse	Contains response data for the get operation.
EnvironmentsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
EnvironmentsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
EnvironmentsUpdateResponse	Contains response data for the update operation.
EventSourceCreateOrUpdateParametersUnion
EventSourceKind	Defines values for EventSourceKind. KnownEventSourceKind can be used interchangeably with EventSourceKind, this enum contains the known values that the service supports. Known values supported by the service Microsoft.EventHub Microsoft.IoTHub
EventSourceResourceKind	Defines values for EventSourceResourceKind. KnownEventSourceResourceKind can be used interchangeably with EventSourceResourceKind, this enum contains the known values that the service supports. Known values supported by the service Microsoft.EventHub Microsoft.IoTHub
EventSourceResourceUnion
EventSourceUpdateParametersUnion
EventSourcesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
EventSourcesGetResponse	Contains response data for the get operation.
EventSourcesListByEnvironmentResponse	Contains response data for the listByEnvironment operation.
EventSourcesUpdateResponse	Contains response data for the update operation.
IngressStartAtType	Defines values for IngressStartAtType. KnownIngressStartAtType can be used interchangeably with IngressStartAtType, this enum contains the known values that the service supports. Known values supported by the service EarliestAvailable EventSourceCreationTime CustomEnqueuedTime
IngressState	Defines values for IngressState. KnownIngressState can be used interchangeably with IngressState, this enum contains the known values that the service supports. Known values supported by the service Disabled Ready Running Paused Unknown
LocalTimestampFormat	Defines values for LocalTimestampFormat. KnownLocalTimestampFormat can be used interchangeably with LocalTimestampFormat, this enum contains the known values that the service supports. Known values supported by the service Embedded
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByEnvironmentResponse	Contains response data for the listByEnvironment operation.
PrivateEndpointServiceConnectionStatus	Defines values for PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected
PrivateLinkResourcesListSupportedResponse	Contains response data for the listSupported operation.
PropertyType	Defines values for PropertyType. KnownPropertyType can be used interchangeably with PropertyType, this enum contains the known values that the service supports. Known values supported by the service String
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Updating Succeeded Failed Deleting
PublicNetworkAccess	Defines values for PublicNetworkAccess. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service enabled disabled
ReferenceDataKeyPropertyType	Defines values for ReferenceDataKeyPropertyType. KnownReferenceDataKeyPropertyType can be used interchangeably with ReferenceDataKeyPropertyType, this enum contains the known values that the service supports. Known values supported by the service String Double Bool DateTime
ReferenceDataSetsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ReferenceDataSetsGetResponse	Contains response data for the get operation.
ReferenceDataSetsListByEnvironmentResponse	Contains response data for the listByEnvironment operation.
ReferenceDataSetsUpdateResponse	Contains response data for the update operation.
SkuName	Defines values for SkuName. KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports. Known values supported by the service S1 S2 P1 L1
StorageLimitExceededBehavior	Defines values for StorageLimitExceededBehavior. KnownStorageLimitExceededBehavior can be used interchangeably with StorageLimitExceededBehavior, this enum contains the known values that the service supports. Known values supported by the service PurgeOldData PauseIngress
WarmStoragePropertiesState	Defines values for WarmStoragePropertiesState. KnownWarmStoragePropertiesState can be used interchangeably with WarmStoragePropertiesState, this enum contains the known values that the service supports. Known values supported by the service Ok Error Unknown

Enums

KnownAccessPolicyRole	Known values of AccessPolicyRole that the service accepts.
KnownDataStringComparisonBehavior	Known values of DataStringComparisonBehavior that the service accepts.
KnownEnvironmentKind	Known values of EnvironmentKind that the service accepts.
KnownEnvironmentResourceKind	Known values of EnvironmentResourceKind that the service accepts.
KnownEventSourceKind	Known values of EventSourceKind that the service accepts.
KnownEventSourceResourceKind	Known values of EventSourceResourceKind that the service accepts.
KnownIngressStartAtType	Known values of IngressStartAtType that the service accepts.
KnownIngressState	Known values of IngressState that the service accepts.
KnownLocalTimestampFormat	Known values of LocalTimestampFormat that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownPropertyType	Known values of PropertyType that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownReferenceDataKeyPropertyType	Known values of ReferenceDataKeyPropertyType that the service accepts.
KnownSkuName	Known values of SkuName that the service accepts.
KnownStorageLimitExceededBehavior	Known values of StorageLimitExceededBehavior that the service accepts.
KnownWarmStoragePropertiesState	Known values of WarmStoragePropertiesState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.