Class: Azure::TimeSeriesInsights::Mgmt::V2017_11_15::Models::IoTHubEventSourceCommonProperties

Inherits:
AzureEventSourceProperties show all
Includes:
MsRestAzure
Defined in:
lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_common_properties.rb

Overview

Properties of the IoTHub event source.

Instance Attribute Summary collapse

Attributes inherited from AzureEventSourceProperties

#event_source_resource_id

Attributes inherited from EventSourceCommonProperties

#timestamp_property_name

Attributes inherited from ResourceProperties

#creation_time, #provisioning_state

Class Method Summary collapse

Instance Attribute Details

#consumer_group_name ⇒ String

the partitions from which events will be read.

Returns:

  • (String) —

    The name of the iot hub’s consumer group that holds



20
21
22
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_common_properties.rb', line 20

def consumer_group_name
  @consumer_group_name
end

#iot_hub_name ⇒ String

Returns The name of the iot hub.

Returns:

  • (String) —

    The name of the iot hub.



16
17
18
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_common_properties.rb', line 16

def iot_hub_name
  @iot_hub_name
end

#key_name ⇒ String

the Time Series Insights service access to the iot hub. This shared access policy key must grant ‘service connect’ permissions to the iot hub.

Returns:

  • (String) —

    The name of the Shared Access Policy key that grants



26
27
28
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_common_properties.rb', line 26

def key_name
  @key_name
end

Class Method Details

.mapper ⇒ Object

Mapper for IoTHubEventSourceCommonProperties class as Ruby Hash. This will be used for serialization/deserialization.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_common_properties.rb', line 33

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'IoTHubEventSourceCommonProperties',
    type: {
      name: 'Composite',
      class_name: 'IoTHubEventSourceCommonProperties',
      model_properties: {
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'creationTime',
          type: {
            name: 'DateTime'
          }
        },
        timestamp_property_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'timestampPropertyName',
          type: {
            name: 'String'
          }
        },
        event_source_resource_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'eventSourceResourceId',
          type: {
            name: 'String'
          }
        },
        iot_hub_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'iotHubName',
          type: {
            name: 'String'
          }
        },
        consumer_group_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'consumerGroupName',
          type: {
            name: 'String'
          }
        },
        key_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'keyName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end