models Package
Classes
| AccessPolicyCreateOrUpdateParameters |
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. Variables are only populated by the server, and will be ignored when sending a request. |
| AccessPolicyUpdateParameters |
AccessPolicyUpdateParameters. |
| AzureEventSourceProperties |
Properties of an event source that reads events from an event broker in Azure. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| 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. All required parameters must be populated in order to send to Azure. |
| EnvironmentCreateOrUpdateParameters |
Parameters supplied to the CreateOrUpdate Environment operation. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Gen1EnvironmentCreateOrUpdateParameters, Gen2EnvironmentCreateOrUpdateParameters. All required parameters must be populated in order to send to Azure. |
| 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. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Gen1EnvironmentResource, Gen2EnvironmentResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| EnvironmentResourceProperties |
Properties of the environment. Variables are only populated by the server, and will be ignored when sending a request. |
| 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. Variables are only populated by the server, and will be ignored when sending a request. |
| EnvironmentUpdateParameters |
Parameters supplied to the Update Environment operation. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Gen1EnvironmentUpdateParameters, Gen2EnvironmentUpdateParameters. Variables are only populated by the server, and will be ignored when sending a request. |
| EventHubEventSourceCommonProperties |
Properties of the EventHub event source. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| EventHubEventSourceCreateOrUpdateParameters |
Parameters supplied to the Create or Update Event Source operation for an EventHub event source. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| EventHubEventSourceCreationProperties |
Properties of the EventHub event source that are required on create or update requests. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| 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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| EventHubEventSourceResourceProperties |
Properties of the EventHub event source resource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| EventHubEventSourceUpdateParameters |
Parameters supplied to the Update Event Source operation to update an EventHub event source. Variables are only populated by the server, and will be ignored when sending a request. |
| EventSourceCommonProperties |
Properties of the event source. Variables are only populated by the server, and will be ignored when sending a request. |
| EventSourceCreateOrUpdateParameters |
Parameters supplied to the Create or Update Event Source operation. You probably want to use the sub-classes and not this class directly. Known sub-classes are: EventHubEventSourceCreateOrUpdateParameters, IoTHubEventSourceCreateOrUpdateParameters. All required parameters must be populated in order to send to Azure. |
| 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. You probably want to use the sub-classes and not this class directly. Known sub-classes are: EventHubEventSourceResource, IoTHubEventSourceResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| EventSourceUpdateParameters |
Parameters supplied to the Update Event Source operation. You probably want to use the sub-classes and not this class directly. Known sub-classes are: EventHubEventSourceUpdateParameters, IoTHubEventSourceUpdateParameters. Variables are only populated by the server, and will be ignored when sending a request. |
| Gen1EnvironmentCreateOrUpdateParameters |
Parameters supplied to the Create or Update Environment operation for a Gen1 environment. All required parameters must be populated in order to send to Azure. |
| Gen1EnvironmentCreationProperties |
Properties used to create a Gen1 environment. All required parameters must be populated in order to send to Azure. |
| 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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Gen1EnvironmentResourceProperties |
Properties of the Gen1 environment. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Gen1EnvironmentUpdateParameters |
Parameters supplied to the Update Environment operation to update a Gen1 environment. Variables are only populated by the server, and will be ignored when sending a request. |
| Gen2EnvironmentCreateOrUpdateParameters |
Parameters supplied to the Create or Update Environment operation for a Gen2 environment. All required parameters must be populated in order to send to Azure. |
| 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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Gen2EnvironmentResourceProperties |
Properties of the Gen2 environment. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Gen2EnvironmentUpdateParameters |
Parameters supplied to the Update Environment operation to update a Gen2 environment. Variables are only populated by the server, and will be ignored when sending a request. |
| 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. All required parameters must be populated in order to send to Azure. |
| 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. All required parameters must be populated in order to send to Azure. |
| Gen2StorageConfigurationOutput |
The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data. All required parameters must be populated in order to send to Azure. |
| IngressEnvironmentStatus |
An object that represents the status of ingress on an environment. Variables are only populated by the server, and will be ignored when sending a request. |
| IoTHubEventSourceCommonProperties |
Properties of the IoTHub event source. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| IoTHubEventSourceCreateOrUpdateParameters |
Parameters supplied to the Create or Update Event Source operation for an IoTHub event source. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| IoTHubEventSourceCreationProperties |
Properties of the IoTHub event source that are required on create or update requests. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| 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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| IoTHubEventSourceResourceProperties |
Properties of the IoTHub event source resource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| IoTHubEventSourceUpdateParameters |
Parameters supplied to the Update Event Source operation to update an IoTHub event source. Variables are only populated by the server, and will be ignored when sending a request. |
| 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. |
| Operation |
A Time Series Insights REST API operation. Variables are only populated by the server, and will be ignored when sending a request. |
| OperationDisplay |
Contains the localized display information for this particular operation / action. Variables are only populated by the server, and will be ignored when sending a request. |
| 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. Variables are only populated by the server, and will be ignored when sending a request. |
| ReferenceDataSetCreateOrUpdateParameters |
ReferenceDataSetCreateOrUpdateParameters. All required parameters must be populated in order to send to Azure. |
| ReferenceDataSetCreationProperties |
Properties used to create a reference data set. All required parameters must be populated in order to send to Azure. |
| 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. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ReferenceDataSetResourceProperties |
Properties of the reference data set. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ReferenceDataSetUpdateParameters |
Parameters supplied to the Update Reference Data Set operation. |
| Resource |
Time Series Insights resource. Variables are only populated by the server, and will be ignored when sending a request. |
| ResourceProperties |
Properties that are common to all tracked resources. Variables are only populated by the server, and will be ignored when sending a request. |
| 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. All required parameters must be populated in order to send to Azure. |
| TimeSeriesIdProperty |
The structure of the property that a time series id can have. An environment can have multiple such properties. |
| TrackedResource |
Time Series Insights resource that is tracked by Azure Resource Manager. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| 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. All required parameters must be populated in order to send to Azure. |
Enums
| AccessPolicyRole |
A role defining the data plane operations that a principal can perform on a Time Series Insights client. |
| DataStringComparisonBehavior |
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. |
| EnvironmentKind |
The kind of the environment. |
| EnvironmentResourceKind |
The kind of the environment. |
| EventSourceKind |
The kind of the event source. |
| EventSourceResourceKind |
The kind of the event source. |
| IngressState |
This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown" |
| LocalTimestampFormat |
An enum that represents the format of the local timestamp property that needs to be set. |
| PropertyType |
The type of the property. |
| ProvisioningState |
Provisioning state of the resource. |
| ReferenceDataKeyPropertyType |
The type of the key property. |
| SkuName |
The name of this SKU. |
| StorageLimitExceededBehavior |
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. |
| WarmStoragePropertiesState |
This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown". |
Feedback
Submit and view feedback for