Event Sources - Update

Service:: Time Series Insights Management

API Version:: 2018-08-15-preview

Updates the event source with the specified name in the specified subscription, resource group, and environment.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName}?api-version=2018-08-15-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Azure Subscription ID.
resourceGroupName	path	True	string	Name of an Azure Resource group.
environmentName	path	True	string	The name of the Time Series Insights environment associated with the specified resource group.
eventSourceName	path	True	string	The name of the Time Series Insights event source associated with the specified environment.
api-version	query	True	string	Version of the API to be used with the client request.

Request Body

Name	Type	Description
tags	object	Key-value pairs of additional properties for the event source.

Responses

Name	Type	Description
200 OK	EventSourceResource: EventHubEventSourceResource IoTHubEventSourceResource	The event source definition was successfully updated and is in the response.
Other Status Codes	CloudError	HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.

Examples

UpdateEventSource

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/eventSources/es1?api-version=2018-08-15-preview

Request Body

{
  "tags": {
    "someKey": "someValue"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1",
  "location": "West US",
  "name": "es1",
  "type": "Microsoft.TimeSeriesInsights/Environments/EventSources",
  "tags": {
    "someKey": "someValue"
  },
  "kind": "Microsoft.EventHub",
  "properties": {
    "eventSourceResourceId": "somePathInArm",
    "serviceBusNamespace": "sbn",
    "consumerGroupName": "cgn",
    "eventHubName": "ehn",
    "keyName": "managementKey",
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.228882Z",
    "timestampPropertyName": "someOtherTimestampProperty"
  }
}

Definitions

CloudError	Contains information about an API error.
CloudErrorBody	Describes a particular API error with an error code and a message.
EventHubEventSourceResource	An event source that receives its data from an Azure EventHub.
EventSourceUpdateParameters	Parameters supplied to the Update Event Source operation.
IoTHubEventSourceResource	An event source that receives its data from an Azure IoTHub.
ProvisioningState	Provisioning state of the resource.

CloudError

Contains information about an API error.

Name	Type	Description
error	CloudErrorBody	Describes a particular API error with an error code and a message.

CloudErrorBody

Describes a particular API error with an error code and a message.

Name	Type	Description
code	string	An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.
details	CloudErrorBody[]	Contains nested errors that are related to this error.
message	string	A message that describes the error in detail and provides debugging information.
target	string	The target of the particular error (for example, the name of the property in error).

EventHubEventSourceResource

An event source that receives its data from an Azure EventHub.

Name	Type	Description
creationTime	string	The time the resource was created.
eventSourceResourceId	string	The resource id of the event source in Azure Resource Manager.
id	string	Resource Id
kind	string: Microsoft.EventHub	The kind of the event source.
location	string	Resource location
name	string	Resource name
properties.consumerGroupName	string	The name of the event hub's consumer group that holds the partitions from which events will be read.
properties.eventHubName	string	The name of the event hub.
properties.keyName	string	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.
properties.serviceBusNamespace	string	The name of the service bus that contains the event hub.
provisioningState	ProvisioningState	Provisioning state of the resource.
tags	object	Resource tags
timestampPropertyName	string	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.
type	string	Resource type

EventSourceUpdateParameters

Parameters supplied to the Update Event Source operation.

Name	Type	Description
tags	object	Key-value pairs of additional properties for the event source.

IoTHubEventSourceResource

An event source that receives its data from an Azure IoTHub.

Name	Type	Description
creationTime	string	The time the resource was created.
eventSourceResourceId	string	The resource id of the event source in Azure Resource Manager.
id	string	Resource Id
kind	string: Microsoft.IotHub	The kind of the event source.
location	string	Resource location
name	string	Resource name
properties.consumerGroupName	string	The name of the iot hub's consumer group that holds the partitions from which events will be read.
properties.iotHubName	string	The name of the iot hub.
properties.keyName	string	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.
provisioningState	ProvisioningState	Provisioning state of the resource.
tags	object	Resource tags
timestampPropertyName	string	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.
type	string	Resource type

ProvisioningState

Provisioning state of the resource.

Name	Type	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string