Class: Azure::TimeSeriesInsights::Mgmt::V2017_11_15::Models::IoTHubEventSourceCreateOrUpdateParameters

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

Overview

Parameters supplied to the Create or Update Event Source operation for an IoTHub event source.

Instance Attribute Summary collapse

Attributes inherited from CreateOrUpdateTrackedResourceProperties

#location, #tags

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ IoTHubEventSourceCreateOrUpdateParameters

Returns a new instance of IoTHubEventSourceCreateOrUpdateParameters.



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

def initialize
  @kind = "Microsoft.IoTHub"
end

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



46
47
48
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 46

def consumer_group_name
  @consumer_group_name
end

#creation_time ⇒ DateTime

Returns The time the resource was created.

Returns:

  • (DateTime) —

    The time the resource was created.



29
30
31
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 29

def creation_time
  @creation_time
end

#event_source_resource_id ⇒ String

Manager.

Returns:

  • (String) —

    The resource id of the event source in Azure Resource



39
40
41
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 39

def event_source_resource_id
  @event_source_resource_id
end

#iot_hub_name ⇒ String

Returns The name of the iot hub.

Returns:

  • (String) —

    The name of the iot hub.



42
43
44
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 42

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



52
53
54
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 52

def key_name
  @key_name
end

#kind ⇒ Object

Returns the value of attribute kind.



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

def kind
  @kind
end

#provisioning_state ⇒ ProvisioningState

Possible values include: ‘Accepted’, ‘Creating’, ‘Updating’, ‘Succeeded’, ‘Failed’, ‘Deleting’

Returns:



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

def provisioning_state
  @provisioning_state
end

#shared_access_key ⇒ String

the Time Series Insights service read access to the iot hub. This property is not shown in event source responses.

Returns:

  • (String) —

    The value of the Shared Access Policy key that grants



57
58
59
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 57

def shared_access_key
  @shared_access_key
end

#timestamp_property_name ⇒ String

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.

Returns:

  • (String) —

    The event property that will be used as the event



35
36
37
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 35

def timestamp_property_name
  @timestamp_property_name
end

Class Method Details

.mapper ⇒ Object

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



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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/2017-11-15/generated/azure_mgmt_time_series_insights/models/io_thub_event_source_create_or_update_parameters.rb', line 65

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Microsoft.IoTHub',
    type: {
      name: 'Composite',
      class_name: 'IoTHubEventSourceCreateOrUpdateParameters',
      model_properties: {
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        kind: {
          client_side_validation: true,
          required: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        timestamp_property_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.timestampPropertyName',
          type: {
            name: 'String'
          }
        },
        event_source_resource_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.eventSourceResourceId',
          type: {
            name: 'String'
          }
        },
        iot_hub_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.iotHubName',
          type: {
            name: 'String'
          }
        },
        consumer_group_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.consumerGroupName',
          type: {
            name: 'String'
          }
        },
        key_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.keyName',
          type: {
            name: 'String'
          }
        },
        shared_access_key: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.sharedAccessKey',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end