azure.mgmt.timeseriesinsights.models.IoTHubEventSourceResource.yml

### YamlMime:PythonClass
uid: azure.mgmt.timeseriesinsights.models.IoTHubEventSourceResource
name: IoTHubEventSourceResource
fullName: azure.mgmt.timeseriesinsights.models.IoTHubEventSourceResource
module: azure.mgmt.timeseriesinsights.models
inheritances:
- azure.mgmt.timeseriesinsights.models._models_py3.EventSourceResource
summary: '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.'
constructor:
  syntax: 'IoTHubEventSourceResource(*, location: str, event_source_resource_id: str,
    iot_hub_name: str, consumer_group_name: str, key_name: str, tags: Dict[str, str]
    | None = None, timestamp_property_name: str | None = None, **kwargs)'
  parameters:
  - name: location
    description: Required. Resource location.
    isRequired: true
    types:
    - <xref:str>
  - name: tags
    description: A set of tags. Resource tags.
    isRequired: true
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: kind
    description: 'Required. The kind of the event source.Constant filled by server.  Possible
      values

      include: "Microsoft.EventHub", "Microsoft.IoTHub".'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.timeseriesinsights.models.EventSourceResourceKind>
  - name: timestamp_property_name
    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.'
    isRequired: true
    types:
    - <xref:str>
  - name: event_source_resource_id
    description: 'Required. The resource id of the event source in Azure

      Resource Manager.'
    isRequired: true
    types:
    - <xref:str>
  - name: iot_hub_name
    description: Required. The name of the iot hub.
    isRequired: true
    types:
    - <xref:str>
  - name: consumer_group_name
    description: 'Required. The name of the iot hub''s consumer group that holds the

      partitions from which events will be read.'
    isRequired: true
    types:
    - <xref:str>
  - name: key_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: location
    isRequired: true
  - name: event_source_resource_id
    isRequired: true
  - name: iot_hub_name
    isRequired: true
  - name: consumer_group_name
    isRequired: true
  - name: key_name
    isRequired: true
  - name: tags
    isRequired: true
  - name: timestamp_property_name
    isRequired: true
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource name.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: 'Provisioning state of the resource. Possible values include:

    "Accepted", "Creating", "Updating", "Succeeded", "Failed", "Deleting".'
  name: provisioning_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.timeseriesinsights.models.ProvisioningState>
- description: The time the resource was created.
  name: creation_time
  types:
  - <xref:datetime.datetime>