IoTHubEventSourceCreateOrUpdateParameters Class

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.

Inheritance

azure.mgmt.timeseriesinsights.models._models_py3.EventSourceCreateOrUpdateParameters

IoTHubEventSourceCreateOrUpdateParameters

Constructor

IoTHubEventSourceCreateOrUpdateParameters(*, location: str, event_source_resource_id: str, iot_hub_name: str, consumer_group_name: str, key_name: str, shared_access_key: str, tags: Optional[Dict[str, str]] = None, local_timestamp: Optional[azure.mgmt.timeseriesinsights.models._models_py3.LocalTimestamp] = None, timestamp_property_name: Optional[str] = None, **kwargs)

Parameters

location

str

Required

Required. The location of the resource.

tags

dict[str, str]

Required

A set of tags. Key-value pairs of additional properties for the resource.

kind

str or EventSourceKind

Required

Required. The kind of the event source.Constant filled by server. Possible values include: "Microsoft.EventHub", "Microsoft.IoTHub".

local_timestamp

LocalTimestamp

Required

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.

timestamp_property_name

str

Required

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.

event_source_resource_id

str

Required

Required. The resource id of the event source in Azure Resource Manager.

iot_hub_name

str

Required

Required. The name of the iot hub.

consumer_group_name

str

Required

Required. The name of the iot hub's consumer group that holds the partitions from which events will be read.

key_name

str

Required

Required. 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.

shared_access_key

str

Required

Required. 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.

Variables

provisioning_state

str or ProvisioningState

Provisioning state of the resource. Possible values include: "Accepted", "Creating", "Updating", "Succeeded", "Failed", "Deleting".

creation_time

datetime

The time the resource was created.