swagger: '2.0' info: title: Microsoft Azure TimeSeriesInsightsClient description: Time Series Insights client version: 2021-06-30-preview host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate your user account paths: /providers/Microsoft.TimeSeriesInsights/operations: get: tags: - Operations operationId: microsoftAzureOperationsList description: Lists all of the available Time Series Insights related operations. x-ms-examples: List available operations for the Time Series Insights resource provider: $ref: ./examples/Operation_List.json parameters: - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successfully listed the available operations. schema: $ref: '#/definitions/OperationListResult' default: description: 'HTTP 404 (Not Found): The list of operations could not be found.' schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Timeseriesinsights Operations ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName} : put: tags: - Environments operationId: microsoftAzureEnvironmentsCreateorupdate x-ms-examples: EnvironmentsCreate: $ref: ./examples/EnvironmentsCreate.json x-ms-long-running-operation: true description: >- Create or update an environment in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - name: environmentName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 description: Name of the environment - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/EnvironmentCreateOrUpdateParameters' description: Parameters for creating an environment resource. responses: '200': description: The existing environment definition was successfully updated. schema: $ref: '#/definitions/EnvironmentResource' '201': description: >- The environment create request was accepted. Environment provisioning is an asynchronous operation. You can periodically get your environment definition and monitor progress via the provisioningState property. schema: $ref: '#/definitions/EnvironmentResource' '404': description: The subscription or resource group could not be found. default: description: >- HTTP 400 (Bad Request): The given environment request body is invalid; See the error code and message in the response for details. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname get: tags: - Environments operationId: microsoftAzureEnvironmentsGet x-ms-examples: EnvironmentsGet: $ref: ./examples/EnvironmentsGet.json description: >- Gets the environment with the specified name in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ExpandParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property. schema: $ref: '#/definitions/EnvironmentResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or environment could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname patch: tags: - Environments operationId: microsoftAzureEnvironmentsUpdate x-ms-examples: EnvironmentsUpdate: $ref: ./examples/EnvironmentsPatchTags.json x-ms-long-running-operation: true description: >- Updates the environment with the specified name in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - name: environmentUpdateParameters in: body required: true schema: $ref: '#/definitions/EnvironmentUpdateParameters' description: >- Request object that contains the updated information for the environment. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- The environment definition was successfully updated and is in the response. If the environment was updated synchronously, the response will include a provisioningState value of "Succeeded". If the environment was updated asynchronously, the response will include a provisioningState value of "Updating". You can periodically get your environment definition and monitor progress of the update via the provisioningState property. schema: $ref: '#/definitions/EnvironmentResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or environment could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname delete: tags: - Environments operationId: microsoftAzureEnvironmentsDelete x-ms-examples: EnvironmentsDelete: $ref: ./examples/EnvironmentsDelete.json description: >- Deletes the environment with the specified name in the specified subscription and resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The environment was successfully deleted. '204': description: The environment was successfully deleted. default: description: >- HTTP 404 (Not Found): The subscription, resource group, or environment could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments: get: tags: - Environments operationId: microsoftAzureEnvironmentsListbyresourcegroup x-ms-examples: EnvironmentsByResourceGroup: $ref: ./examples/EnvironmentsListByResourceGroup.json description: >- Lists all the available environments associated with the subscription and within the specified resource group. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Environments returned successfully. schema: $ref: '#/definitions/EnvironmentListResponse' default: description: >- HTTP 404 (Not Found): The subscription, or resource group could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments /subscriptions/{subscriptionId}/providers/Microsoft.TimeSeriesInsights/environments: get: tags: - Environments operationId: microsoftAzureEnvironmentsListbysubscription x-ms-examples: EnvironmentsBySubscription: $ref: ./examples/EnvironmentsListBySubscription.json description: >- Lists all the available environments within a subscription, irrespective of the resource groups. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Environments returned successfully. schema: $ref: '#/definitions/EnvironmentListResponse' default: description: 'HTTP 404 (Not Found): The subscription could not be found.' schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Timeseriesinsights Environments ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName} : put: tags: - EventSources operationId: microsoftAzureEventsourcesCreateorupdate x-ms-examples: CreateEventHubEventSource: $ref: ./examples/EventSourcesCreateEventHub.json EventSourcesCreateEventHubWithCustomEnquedTime: $ref: ./examples/EventSourcesCreateEventHubWithCustomEnquedTime.json description: Create or update an event source under the specified environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - name: eventSourceName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 description: Name of the event source. - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/EventSourceCreateOrUpdateParameters' description: Parameters for creating an event source resource. responses: '200': description: The existing event source definition was successfully updated. schema: $ref: '#/definitions/EventSourceResource' '201': description: The event source was successfully created. schema: $ref: '#/definitions/EventSourceResource' default: description: >- HTTP 400 (Bad Request): The given event source request body is invalid; See the error code and message in the response for details. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Eventsources Eventsourcename get: tags: - EventSources operationId: microsoftAzureEventsourcesGet x-ms-examples: GetEventHubEventSource: $ref: ./examples/EventSourcesGetEventHub.json description: >- Gets the event source with the specified name in the specified environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/EventSourceNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- The event source definition was successfully retrieved and is in the response. schema: $ref: '#/definitions/EventSourceResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Eventsources Eventsourcename patch: tags: - EventSources operationId: microsoftAzureEventsourcesUpdate x-ms-examples: UpdateEventSource: $ref: ./examples/EventSourcesPatchTags.json description: >- Updates the event source with the specified name in the specified subscription, resource group, and environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/EventSourceNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: eventSourceUpdateParameters in: body required: true schema: $ref: '#/definitions/EventSourceUpdateParameters' description: >- Request object that contains the updated information for the event source. responses: '200': description: >- The event source definition was successfully updated and is in the response. schema: $ref: '#/definitions/EventSourceResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Eventsources Eventsourcename delete: tags: - EventSources operationId: microsoftAzureEventsourcesDelete x-ms-examples: DeleteEventSource: $ref: ./examples/EventSourcesDelete.json description: >- Deletes the event source with the specified name in the specified subscription, resource group, and environment parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/EventSourceNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The event source was successfully deleted. '204': description: The event source was successfully deleted. default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Eventsources Eventsourcename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources : get: tags: - EventSources operationId: microsoftAzureEventsourcesListbyenvironment x-ms-examples: ListEventSourcesByEnvironment: $ref: ./examples/EventSourcesListByEnvironment.json description: >- Lists all the available event sources associated with the subscription and within the specified resource group and environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Environments returned successfully. schema: $ref: '#/definitions/EventSourceListResponse' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or environment could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Eventsources ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName} : put: tags: - ReferenceDataSets operationId: microsoftAzureReferencedatasetsCreateorupdate x-ms-examples: ReferenceDataSetsCreate: $ref: ./examples/ReferenceDataSetsCreate.json description: Create or update a reference data set in the specified environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - name: referenceDataSetName in: path required: true type: string pattern: ^[A-Za-z0-9] minLength: 3 maxLength: 63 description: Name of the reference data set. - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/ReferenceDataSetCreateOrUpdateParameters' description: Parameters for creating a reference data set. responses: '200': description: The existing reference data set definition was successfully updated. schema: $ref: '#/definitions/ReferenceDataSetResource' '201': description: The reference data set was successfully created. schema: $ref: '#/definitions/ReferenceDataSetResource' default: description: >- HTTP 400 (Bad Request): The given reference data set request body is invalid; See the error code and message in the response for details. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname get: tags: - ReferenceDataSets operationId: microsoftAzureReferencedatasetsGet x-ms-examples: ReferenceDataSetsGet: $ref: ./examples/ReferenceDataSetsGet.json description: >- Gets the reference data set with the specified name in the specified environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ReferenceDataSetNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- The reference data set definition was successfully retrieved and is in the response. schema: $ref: '#/definitions/ReferenceDataSetResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname patch: tags: - ReferenceDataSets operationId: microsoftAzureReferencedatasetsUpdate x-ms-examples: ReferenceDataSetsUpdate: $ref: ./examples/ReferenceDataSetsPatchTags.json description: >- Updates the reference data set with the specified name in the specified subscription, resource group, and environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ReferenceDataSetNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: referenceDataSetUpdateParameters in: body required: true schema: $ref: '#/definitions/ReferenceDataSetUpdateParameters' description: >- Request object that contains the updated information for the reference data set. responses: '200': description: >- The reference data set definition was successfully updated and is in the response. schema: $ref: '#/definitions/ReferenceDataSetResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname delete: tags: - ReferenceDataSets operationId: microsoftAzureReferencedatasetsDelete x-ms-examples: ReferenceDataSetsDelete: $ref: ./examples/ReferenceDataSetsDelete.json description: >- Deletes the reference data set with the specified name in the specified subscription, resource group, and environment parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ReferenceDataSetNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The reference data set was successfully deleted. '204': description: The reference data set was successfully deleted. default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets Referencedatasetname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets : get: tags: - ReferenceDataSets operationId: microsoftAzureReferencedatasetsListbyenvironment x-ms-examples: ReferenceDataSetsListByEnvironment: $ref: ./examples/ReferenceDataSetsListByEnvironment.json description: >- Lists all the available reference data sets associated with the subscription and within the specified resource group and environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Reference data sets returned successfully. schema: $ref: '#/definitions/ReferenceDataSetListResponse' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or environment could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Referencedatasets ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies/{accessPolicyName} : put: tags: - AccessPolicies operationId: microsoftAzureAccesspoliciesCreateorupdate x-ms-examples: AccessPoliciesCreate: $ref: ./examples/AccessPoliciesCreate.json description: Create or update an access policy in the specified environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - name: accessPolicyName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 description: Name of the access policy. - $ref: '#/parameters/ApiVersionParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/AccessPolicyCreateOrUpdateParameters' description: Parameters for creating an access policy. responses: '200': description: The existing access policy definition was successfully updated. schema: $ref: '#/definitions/AccessPolicyResource' '201': description: The access policy was successfully created. schema: $ref: '#/definitions/AccessPolicyResource' default: description: >- HTTP 400 (Bad Request): The given access policy request body is invalid; See the error code and message in the response for details. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Accesspolicies Accesspolicyname get: tags: - AccessPolicies operationId: microsoftAzureAccesspoliciesGet x-ms-examples: AccessPoliciesGet: $ref: ./examples/AccessPoliciesGet.json description: >- Gets the access policy with the specified name in the specified environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/AccessPolicyNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: >- The access policy definition was successfully retrieved and is in the response. schema: $ref: '#/definitions/AccessPolicyResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Accesspolicies Accesspolicyname patch: tags: - AccessPolicies operationId: microsoftAzureAccesspoliciesUpdate x-ms-examples: AccessPoliciesUpdate: $ref: ./examples/AccessPoliciesPatchRoles.json description: >- Updates the access policy with the specified name in the specified subscription, resource group, and environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/AccessPolicyNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: accessPolicyUpdateParameters in: body required: true schema: $ref: '#/definitions/AccessPolicyUpdateParameters' description: >- Request object that contains the updated information for the access policy. responses: '200': description: >- The access policy definition was successfully updated and is in the response. schema: $ref: '#/definitions/AccessPolicyResource' default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Accesspolicies Accesspolicyname delete: tags: - AccessPolicies operationId: microsoftAzureAccesspoliciesDelete x-ms-examples: AccessPoliciesDelete: $ref: ./examples/AccessPoliciesDelete.json description: >- Deletes the access policy with the specified name in the specified subscription, resource group, and environment parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/AccessPolicyNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: The access policy was successfully deleted. '204': description: The access policy was successfully deleted. default: description: >- HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Accesspolicies Accesspolicyname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies : get: tags: - AccessPolicies operationId: microsoftAzureAccesspoliciesListbyenvironment x-ms-examples: AccessPoliciesByEnvironment: $ref: ./examples/AccessPoliciesListByEnvironment.json description: Lists all the available access policies associated with the environment. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/EnvironmentNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: access policies returned successfully. schema: $ref: '#/definitions/AccessPolicyListResponse' default: description: >- HTTP 404 (Not Found): The subscription, resource group, or environment could not be found. schema: $ref: '#/definitions/CloudError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Timeseriesinsights Environments Environmentname Accesspolicies definitions: OperationListResult: description: >- 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. properties: value: description: >- List of Time Series Insights operations supported by the Microsoft.TimeSeriesInsights resource provider. type: array readOnly: true items: $ref: '#/definitions/Operation' x-ms-identifiers: - name nextLink: description: URL to get the next set of operation list results if there are any. type: string readOnly: true Operation: description: A Time Series Insights REST API operation type: object properties: name: description: The name of the operation being performed on this particular object. type: string readOnly: true display: description: >- Contains the localized display information for this particular operation / action. readOnly: true properties: provider: description: The localized friendly form of the resource provider name. type: string readOnly: true resource: description: >- The localized friendly form of the resource type related to this action/operation. type: string readOnly: true operation: description: The localized friendly name for the operation. type: string readOnly: true description: description: The localized friendly description for the operation. type: string readOnly: true origin: title: The intended executor of the operation. type: string properties: title: Properties of the operation, including metric specifications. type: object x-ms-client-flatten: true x-ms-client-name: OperationProperties $ref: '#/definitions/OperationProperties' OperationProperties: description: Properties of operation, include metric specifications. type: object properties: serviceSpecification: $ref: '#/definitions/ServiceSpecification' description: One property of operation, include metric specifications. ServiceSpecification: description: One property of operation, include metric specifications. type: object properties: metricSpecifications: description: Metric specifications of operation. type: array items: $ref: '#/definitions/MetricSpecification' x-ms-identifiers: - name - unit logSpecifications: description: A list of Azure Monitoring log definitions. type: array items: $ref: '#/definitions/LogSpecification' x-ms-identifiers: - name MetricSpecification: description: Metric specification of operation. type: object properties: name: type: string description: Name of metric specification. displayName: type: string description: Display name of metric specification. displayDescription: type: string description: Display description of metric specification. unit: type: string description: Unit could be Bytes or Count. dimensions: description: Dimensions of blobs, including blob type and access tier. type: array items: $ref: '#/definitions/Dimension' x-ms-identifiers: - name aggregationType: type: string description: Aggregation type could be Average. availabilities: description: Retention policies of a resource metric. type: array items: $ref: '#/definitions/MetricAvailability' x-ms-identifiers: - timeGrain category: type: string description: The category this metric specification belong to, could be Capacity. resourceIdDimensionNameOverride: type: string description: Account Resource Id. LogSpecification: description: The specification of an Azure Monitoring log. type: object properties: name: description: Log name. type: string displayName: description: Log display name. type: string Dimension: description: Dimension of blobs, possibly be blob type or access tier. type: object properties: name: type: string description: Display name of dimension. displayName: type: string description: Display name of dimension. MetricAvailability: description: Retention policy of a resource metric. type: object properties: timeGrain: type: string blobDuration: type: string Resource: properties: id: readOnly: true type: string description: Resource Id name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type description: Time Series Insights resource x-ms-azure-resource: true TrackedResource: properties: location: type: string description: Resource location x-ms-mutability: - read - create tags: type: object additionalProperties: type: string description: Resource tags allOf: - $ref: '#/definitions/Resource' required: - location description: Time Series Insights resource that is tracked by Azure Resource Manager. ResourceProperties: properties: provisioningState: $ref: '#/definitions/ProvisioningState' description: Provisioning state of the resource. creationTime: readOnly: true type: string format: date-time description: The time the resource was created. description: Properties that are common to all tracked resources. ProvisioningState: readOnly: true type: string description: Provisioning state of the resource. enum: - Accepted - Creating - Updating - Succeeded - Failed - Deleting x-ms-enum: name: ProvisioningState modelAsString: true Sku: type: object properties: name: type: string description: The name of this SKU. enum: - S1 - S2 - P1 - L1 x-ms-enum: name: SkuName modelAsString: true capacity: format: int32 type: integer description: >- The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created. minimum: 1 maximum: 10 required: - name - capacity description: >- 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. WarmStoreConfigurationProperties: type: object properties: dataRetention: type: string format: duration description: >- ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store. required: - dataRetention description: >- 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. Gen2StorageConfigurationInput: type: object properties: accountName: type: string description: >- The name of the storage account that will hold the environment's Gen2 data. managementKey: type: string description: >- The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses. required: - accountName - managementKey description: >- 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: type: object properties: accountName: type: string description: >- The name of the storage account that will hold the environment's Gen2 data. required: - accountName description: >- The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data. Gen2StorageConfigurationMutableProperties: type: object properties: managementKey: type: string description: >- The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses. required: - managementKey description: >- 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. CreateOrUpdateTrackedResourceProperties: properties: location: type: string description: The location of the resource. x-ms-mutability: - read - create tags: type: object additionalProperties: type: string description: Key-value pairs of additional properties for the resource. required: - location description: >- Properties required to create any resource tracked by Azure Resource Manager. EnvironmentCreateOrUpdateParameters: discriminator: kind properties: kind: type: string description: The kind of the environment. enum: - Gen1 - Gen2 x-ms-enum: name: EnvironmentKind modelAsString: true x-ms-mutability: - create - read sku: $ref: '#/definitions/Sku' description: >- 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. required: - kind - sku allOf: - $ref: '#/definitions/CreateOrUpdateTrackedResourceProperties' description: Parameters supplied to the CreateOrUpdate Environment operation. Gen1EnvironmentCreateOrUpdateParameters: x-ms-discriminator-value: Gen1 properties: properties: x-ms-client-flatten: true $ref: '#/definitions/Gen1EnvironmentCreationProperties' required: - properties allOf: - $ref: '#/definitions/EnvironmentCreateOrUpdateParameters' description: >- Parameters supplied to the Create or Update Environment operation for a Gen1 environment. Gen2EnvironmentCreateOrUpdateParameters: x-ms-discriminator-value: Gen2 properties: properties: x-ms-client-flatten: true $ref: '#/definitions/Gen2EnvironmentCreationProperties' required: - properties allOf: - $ref: '#/definitions/EnvironmentCreateOrUpdateParameters' description: >- Parameters supplied to the Create or Update Environment operation for a Gen2 environment. EnvironmentUpdateParameters: type: object discriminator: kind properties: kind: type: string description: The kind of the environment. enum: - Gen1 - Gen2 x-ms-enum: name: EnvironmentKind modelAsString: true tags: type: object additionalProperties: type: string description: Key-value pairs of additional properties for the environment. required: - kind description: Parameters supplied to the Update Environment operation. Gen1EnvironmentUpdateParameters: type: object x-ms-discriminator-value: Gen1 properties: sku: $ref: '#/definitions/Sku' description: The sku of the environment. properties: x-ms-client-flatten: true $ref: '#/definitions/Gen1EnvironmentMutableProperties' description: Properties of the Gen1 environment. allOf: - $ref: '#/definitions/EnvironmentUpdateParameters' description: >- Parameters supplied to the Update Environment operation to update a Gen1 environment. Gen2EnvironmentUpdateParameters: type: object x-ms-discriminator-value: Gen2 properties: properties: x-ms-client-flatten: true $ref: '#/definitions/Gen2EnvironmentMutableProperties' description: Properties of the Gen2 environment. allOf: - $ref: '#/definitions/EnvironmentUpdateParameters' description: >- Parameters supplied to the Update Environment operation to update a Gen2 environment. EnvironmentListResponse: properties: value: type: array items: $ref: '#/definitions/EnvironmentResource' description: Result of the List Environments operation. description: The response of the List Environments operation. EnvironmentResource: type: object discriminator: kind properties: sku: $ref: '#/definitions/Sku' description: >- 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. kind: type: string description: The kind of the environment. enum: - Gen1 - Gen2 required: - kind - sku allOf: - $ref: '#/definitions/TrackedResource' description: >- An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen1EnvironmentResource: x-ms-discriminator-value: Gen1 properties: properties: x-ms-client-flatten: true $ref: '#/definitions/Gen1EnvironmentResourceProperties' required: - properties allOf: - $ref: '#/definitions/EnvironmentResource' description: >- 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. Gen2EnvironmentResource: x-ms-discriminator-value: Gen2 properties: properties: x-ms-client-flatten: true $ref: '#/definitions/Gen2EnvironmentResourceProperties' required: - properties allOf: - $ref: '#/definitions/EnvironmentResource' description: >- 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. Gen1EnvironmentCreationProperties: properties: dataRetentionTime: type: string format: duration description: >- ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. storageLimitExceededBehavior: type: string description: >- 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. enum: - PurgeOldData - PauseIngress x-ms-enum: name: StorageLimitExceededBehavior modelAsString: true partitionKeyProperties: type: array items: $ref: '#/definitions/TimeSeriesIdProperty' x-ms-identifiers: - name description: >- The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported. required: - dataRetentionTime description: Properties used to create a Gen1 environment. Gen2EnvironmentCreationProperties: properties: timeSeriesIdProperties: type: array items: $ref: '#/definitions/TimeSeriesIdProperty' x-ms-identifiers: - name description: >- The list of event properties which will be used to define the environment's time series id. storageConfiguration: $ref: '#/definitions/Gen2StorageConfigurationInput' description: >- 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. warmStoreConfiguration: x-ms-client-flatten: false $ref: '#/definitions/WarmStoreConfigurationProperties' description: >- 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. required: - timeSeriesIdProperties - storageConfiguration description: Properties used to create a Gen2 environment. EnvironmentResourceProperties: properties: dataAccessId: readOnly: true type: string format: uuid description: >- An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment. dataAccessFqdn: readOnly: true type: string description: >- The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment. supportsCustomerManagedKey: readOnly: true type: boolean description: >- Indicates whether an environment supports Encryption at Rest with Customer Managed Key. status: $ref: '#/definitions/EnvironmentStatus' description: >- An object that represents the status of the environment, and its internal state in the Time Series Insights service. allOf: - $ref: '#/definitions/ResourceProperties' description: Properties of the environment. Gen1EnvironmentResourceProperties: allOf: - $ref: '#/definitions/Gen1EnvironmentCreationProperties' - $ref: '#/definitions/EnvironmentResourceProperties' required: - dataRetentionTime description: Properties of the Gen1 environment. Gen2EnvironmentResourceProperties: properties: timeSeriesIdProperties: type: array items: $ref: '#/definitions/TimeSeriesIdProperty' x-ms-identifiers: - name description: >- The list of event properties which will be used to define the environment's time series id. storageConfiguration: $ref: '#/definitions/Gen2StorageConfigurationOutput' description: >- 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. warmStoreConfiguration: x-ms-client-flatten: false $ref: '#/definitions/WarmStoreConfigurationProperties' description: >- 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. required: - timeSeriesIdProperties - storageConfiguration allOf: - $ref: '#/definitions/EnvironmentResourceProperties' description: Properties of the Gen2 environment. Gen1EnvironmentMutableProperties: description: >- An object that represents a set of mutable Gen1 environment resource properties. type: object properties: dataRetentionTime: type: string format: duration description: >- ISO8601 timespan specifying the minimum number of days the environment's events will be available for query. storageLimitExceededBehavior: type: string description: >- 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. enum: - PurgeOldData - PauseIngress x-ms-enum: name: StorageLimitExceededBehavior modelAsString: true Gen2EnvironmentMutableProperties: description: >- An object that represents a set of mutable Gen2 environment resource properties. type: object properties: storageConfiguration: $ref: '#/definitions/Gen2StorageConfigurationMutableProperties' description: >- 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. warmStoreConfiguration: x-ms-client-flatten: false $ref: '#/definitions/WarmStoreConfigurationProperties' description: >- 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. TimeSeriesIdProperty: properties: name: type: string description: The name of the property. type: type: string description: The type of the property. enum: - String x-ms-enum: name: PropertyType modelAsString: true description: >- The structure of the property that a time series id can have. An environment can have multiple such properties. EnvironmentStatus: readOnly: true type: object description: >- An object that represents the status of the environment, and its internal state in the Time Series Insights service. properties: ingress: $ref: '#/definitions/IngressEnvironmentStatus' description: An object that represents the status of ingress on an environment. warmStorage: $ref: '#/definitions/WarmStorageEnvironmentStatus' description: >- An object that represents the status of warm storage on an environment. IngressEnvironmentStatus: readOnly: true type: object description: An object that represents the status of ingress on an environment. properties: state: type: string description: >- This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown" enum: - Disabled - Ready - Running - Paused - Unknown x-ms-enum: name: IngressState modelAsString: true stateDetails: $ref: '#/definitions/EnvironmentStateDetails' description: An object that contains the details about an environment's state. EnvironmentStateDetails: readOnly: true type: object description: An object that contains the details about an environment's state. properties: code: type: string description: >- Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases. message: type: string description: A message that describes the state in detail. WarmStorageEnvironmentStatus: readOnly: true type: object description: An object that represents the status of warm storage on an environment. properties: propertiesUsage: x-ms-client-flatten: true $ref: '#/definitions/WarmStoragePropertiesUsage' description: An object that contains the status of warm storage properties usage. WarmStoragePropertiesUsage: readOnly: true type: object description: An object that contains the status of warm storage properties usage. properties: state: type: string description: >- This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown". enum: - Ok - Error - Unknown x-ms-enum: name: WarmStoragePropertiesState modelAsString: true stateDetails: x-ms-client-flatten: true $ref: '#/definitions/WarmStoragePropertiesUsageStateDetails' description: >- An object that contains the details about warm storage properties usage state. WarmStoragePropertiesUsageStateDetails: readOnly: true type: object description: >- An object that contains the details about warm storage properties usage state. properties: currentCount: format: int32 type: integer description: >- A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU minimum: 1 maximum: 10 maxCount: format: int32 type: integer description: >- A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU. minimum: 1 maximum: 10 IngressStartAtProperties: type: object description: >- An object that contains the details about the starting point in time to ingest events. properties: type: type: string description: >- The type of the ingressStartAt, It can be "EarliestAvailable", "EventSourceCreationTime", "CustomEnqueuedTime". enum: - EarliestAvailable - EventSourceCreationTime - CustomEnqueuedTime x-ms-enum: name: IngressStartAtType modelAsString: true time: type: string description: >- 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. EventSourceCreateOrUpdateParameters: discriminator: kind properties: kind: type: string description: The kind of the event source. enum: - Microsoft.EventHub - Microsoft.IoTHub x-ms-enum: name: EventSourceKind modelAsString: true localTimestamp: $ref: '#/definitions/LocalTimestamp' description: >- 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. required: - kind allOf: - $ref: '#/definitions/CreateOrUpdateTrackedResourceProperties' description: Parameters supplied to the Create or Update Event Source operation. EventHubEventSourceCreateOrUpdateParameters: x-ms-discriminator-value: Microsoft.EventHub properties: properties: x-ms-client-flatten: true $ref: '#/definitions/EventHubEventSourceCreationProperties' required: - properties allOf: - $ref: '#/definitions/EventSourceCreateOrUpdateParameters' description: >- Parameters supplied to the Create or Update Event Source operation for an EventHub event source. IoTHubEventSourceCreateOrUpdateParameters: x-ms-discriminator-value: Microsoft.IoTHub properties: properties: x-ms-client-flatten: true $ref: '#/definitions/IoTHubEventSourceCreationProperties' required: - properties allOf: - $ref: '#/definitions/EventSourceCreateOrUpdateParameters' description: >- Parameters supplied to the Create or Update Event Source operation for an IoTHub event source. EventSourceUpdateParameters: discriminator: kind type: object properties: kind: type: string description: The kind of the event source. enum: - Microsoft.EventHub - Microsoft.IoTHub x-ms-enum: name: EventSourceKind modelAsString: true tags: type: object additionalProperties: type: string description: Key-value pairs of additional properties for the event source. required: - kind description: Parameters supplied to the Update Event Source operation. EventHubEventSourceUpdateParameters: type: object x-ms-discriminator-value: Microsoft.EventHub properties: properties: x-ms-client-flatten: true $ref: '#/definitions/EventHubEventSourceMutableProperties' description: Properties of the EventHub event source. allOf: - $ref: '#/definitions/EventSourceUpdateParameters' description: >- Parameters supplied to the Update Event Source operation to update an EventHub event source. IoTHubEventSourceUpdateParameters: x-ms-discriminator-value: Microsoft.IoTHub type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/IoTHubEventSourceMutableProperties' description: Properties of the IoTHub event source. allOf: - $ref: '#/definitions/EventSourceUpdateParameters' description: >- Parameters supplied to the Update Event Source operation to update an IoTHub event source. EventSourceListResponse: properties: value: type: array items: $ref: '#/definitions/EventSourceResource' description: Result of the List EventSources operation. description: The response of the List EventSources operation. EventSourceResource: type: object discriminator: kind properties: kind: type: string description: The kind of the event source. enum: - Microsoft.EventHub - Microsoft.IoTHub required: - kind allOf: - $ref: '#/definitions/TrackedResource' description: >- 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 EventHubEventSourceResource: x-ms-discriminator-value: Microsoft.EventHub properties: properties: x-ms-client-flatten: true $ref: '#/definitions/EventHubEventSourceResourceProperties' required: - properties allOf: - $ref: '#/definitions/EventSourceResource' description: An event source that receives its data from an Azure EventHub. IoTHubEventSourceResource: x-ms-discriminator-value: Microsoft.IoTHub properties: properties: x-ms-client-flatten: true $ref: '#/definitions/IoTHubEventSourceResourceProperties' required: - properties allOf: - $ref: '#/definitions/EventSourceResource' description: An event source that receives its data from an Azure IoTHub. EventSourceCommonProperties: properties: timestampPropertyName: type: string description: >- 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. localTimestamp: $ref: '#/definitions/LocalTimestamp' description: >- 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. ingressStartAt: x-ms-client-flatten: true $ref: '#/definitions/IngressStartAtProperties' description: >- An object that contains the details about the starting point in time to ingest events. allOf: - $ref: '#/definitions/ResourceProperties' description: Properties of the event source. AzureEventSourceProperties: properties: eventSourceResourceId: type: string description: The resource id of the event source in Azure Resource Manager. allOf: - $ref: '#/definitions/EventSourceCommonProperties' required: - eventSourceResourceId description: >- Properties of an event source that reads events from an event broker in Azure. EventHubEventSourceCommonProperties: properties: serviceBusNamespace: type: string description: The name of the service bus that contains the event hub. eventHubName: type: string description: The name of the event hub. consumerGroupName: type: string description: >- The name of the event hub's consumer group that holds the partitions from which events will be read. keyName: type: string description: >- 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. allOf: - $ref: '#/definitions/AzureEventSourceProperties' required: - serviceBusNamespace - eventHubName - consumerGroupName - keyName description: Properties of the EventHub event source. EventHubEventSourceCreationProperties: properties: sharedAccessKey: type: string description: >- 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. allOf: - $ref: '#/definitions/EventHubEventSourceCommonProperties' required: - sharedAccessKey description: >- Properties of the EventHub event source that are required on create or update requests. EventHubEventSourceResourceProperties: allOf: - $ref: '#/definitions/EventHubEventSourceCommonProperties' description: Properties of the EventHub event source resource. IoTHubEventSourceCommonProperties: properties: iotHubName: type: string description: The name of the iot hub. consumerGroupName: type: string description: >- The name of the iot hub's consumer group that holds the partitions from which events will be read. keyName: type: string description: >- 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. allOf: - $ref: '#/definitions/AzureEventSourceProperties' required: - iotHubName - consumerGroupName - keyName description: Properties of the IoTHub event source. IoTHubEventSourceCreationProperties: properties: sharedAccessKey: type: string description: >- 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. allOf: - $ref: '#/definitions/IoTHubEventSourceCommonProperties' required: - sharedAccessKey description: >- Properties of the IoTHub event source that are required on create or update requests. IoTHubEventSourceResourceProperties: allOf: - $ref: '#/definitions/IoTHubEventSourceCommonProperties' description: Properties of the IoTHub event source resource. LocalTimestamp: description: >- 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. type: object properties: format: description: >- An enum that represents the format of the local timestamp property that needs to be set. type: string enum: - Embedded x-ms-enum: name: LocalTimestampFormat modelAsString: true timeZoneOffset: description: >- An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded. type: object properties: propertyName: type: string description: >- The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00) EventSourceMutableProperties: description: >- An object that represents a set of mutable event source resource properties. type: object properties: timestampPropertyName: type: string description: >- 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. EventHubEventSourceMutableProperties: description: >- An object that represents a set of mutable EventHub event source resource properties. type: object properties: sharedAccessKey: type: string description: >- 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. allOf: - $ref: '#/definitions/EventSourceMutableProperties' IoTHubEventSourceMutableProperties: description: >- An object that represents a set of mutable IoTHub event source resource properties. type: object properties: sharedAccessKey: type: string description: >- 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. allOf: - $ref: '#/definitions/EventSourceMutableProperties' ReferenceDataSetCreateOrUpdateParameters: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ReferenceDataSetCreationProperties' required: - properties allOf: - $ref: '#/definitions/CreateOrUpdateTrackedResourceProperties' ReferenceDataSetUpdateParameters: type: object properties: tags: type: object additionalProperties: type: string description: Key-value pairs of additional properties for the reference data set. description: Parameters supplied to the Update Reference Data Set operation. ReferenceDataSetListResponse: properties: value: type: array items: $ref: '#/definitions/ReferenceDataSetResource' description: Result of the List Reference Data Sets operation. description: The response of the List Reference Data Sets operation. ReferenceDataSetResource: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ReferenceDataSetResourceProperties' allOf: - $ref: '#/definitions/TrackedResource' description: >- 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. ReferenceDataSetCreationProperties: properties: keyProperties: type: array items: $ref: '#/definitions/ReferenceDataSetKeyProperty' x-ms-identifiers: - name description: The list of key properties for the reference data set. dataStringComparisonBehavior: type: string description: >- 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. enum: - Ordinal - OrdinalIgnoreCase x-ms-enum: name: DataStringComparisonBehavior modelAsString: true required: - keyProperties description: Properties used to create a reference data set. ReferenceDataSetResourceProperties: allOf: - $ref: '#/definitions/ReferenceDataSetCreationProperties' - $ref: '#/definitions/ResourceProperties' required: - keyProperties description: Properties of the reference data set. ReferenceDataSetKeyProperty: properties: name: type: string description: The name of the key property. type: type: string description: The type of the key property. enum: - String - Double - Bool - DateTime x-ms-enum: name: ReferenceDataKeyPropertyType modelAsString: true description: >- A key property for the reference data set. A reference data set can have multiple key properties. AccessPolicyCreateOrUpdateParameters: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AccessPolicyResourceProperties' required: - properties AccessPolicyUpdateParameters: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AccessPolicyMutableProperties' AccessPolicyListResponse: properties: value: type: array items: $ref: '#/definitions/AccessPolicyResource' description: Result of the List access policies operation. description: The response of the List access policies operation. AccessPolicyResource: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AccessPolicyResourceProperties' allOf: - $ref: '#/definitions/Resource' description: >- 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. AccessPolicyResourceProperties: properties: principalObjectId: type: string description: The objectId of the principal in Azure Active Directory. x-ms-mutability: - create - read description: type: string description: An description of the access policy. roles: type: array items: type: string description: >- A role defining the data plane operations that a principal can perform on a Time Series Insights client. enum: - Reader - Contributor x-ms-enum: name: AccessPolicyRole modelAsString: true description: The list of roles the principal is assigned on the environment. AccessPolicyMutableProperties: description: >- An object that represents a set of mutable access policy resource properties. type: object properties: description: type: string description: An description of the access policy. roles: type: array items: type: string description: >- A role defining the data plane operations that a principal can perform on a Time Series Insights client. enum: - Reader - Contributor x-ms-enum: name: AccessPolicyRole modelAsString: true description: The list of roles the principal is assigned on the environment. CloudError: type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: Describes a particular API error with an error code and a message. description: Contains information about an API error. x-ms-external: true CloudErrorBody: type: object description: Describes a particular API error with an error code and a message. properties: code: type: string description: >- An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. message: type: string description: >- A message that describes the error in detail and provides debugging information. target: type: string description: >- The target of the particular error (for example, the name of the property in error). details: type: array items: $ref: '#/definitions/CloudErrorBody' description: Describes a particular API error with an error code and a message. x-ms-identifiers: [] description: Contains nested errors that are related to this error. x-ms-external: true parameters: SubscriptionIdParameter: name: subscriptionId in: path description: Azure Subscription ID. required: true type: string ApiVersionParameter: name: api-version in: query required: true type: string description: Version of the API to be used with the client request. ExpandParameter: name: $expand in: query required: false type: string x-ms-parameter-location: method description: >- Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service. ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string x-ms-parameter-location: method description: Name of an Azure Resource group. EnvironmentNameParameter: name: environmentName in: path required: true type: string description: >- The name of the Time Series Insights environment associated with the specified resource group. x-ms-parameter-location: method EventSourceNameParameter: name: eventSourceName in: path required: true type: string description: >- The name of the Time Series Insights event source associated with the specified environment. x-ms-parameter-location: method ReferenceDataSetNameParameter: name: referenceDataSetName in: path required: true type: string description: >- The name of the Time Series Insights reference data set associated with the specified environment. x-ms-parameter-location: method AccessPolicyNameParameter: name: accessPolicyName in: path required: true type: string description: >- The name of the Time Series Insights access policy associated with the specified environment. x-ms-parameter-location: method tags: - name: AccessPolicies - name: Environments - name: EventSources - name: Operations - name: ReferenceDataSets