Class: Azure::IotHub::Mgmt::V2019_07_01_preview::Models::IotHubProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb

Overview

The properties of an IoT hub.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#authorization_policies ⇒ Array<SharedAccessSignatureAuthorizationRule>

access policies you can use to secure a connection to the IoT hub.

Returns:



17
18
19
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 17

def authorization_policies
  @authorization_policies
end

#cloud_to_device ⇒ CloudToDeviceProperties

Returns:



57
58
59
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 57

def cloud_to_device
  @cloud_to_device
end

#comments ⇒ String

Returns IoT hub comments.

Returns:

  • (String) —

    IoT hub comments.



60
61
62
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 60

def comments
  @comments
end

#device_streams ⇒ IotHubPropertiesDeviceStreams

of iothub.

Returns:



64
65
66
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 64

def device_streams
  @device_streams
end

#enable_file_upload_notifications ⇒ Boolean

Returns If True, file upload notifications are enabled.

Returns:

  • (Boolean) —

    If True, file upload notifications are enabled.



54
55
56
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 54

def enable_file_upload_notifications
  @enable_file_upload_notifications
end

#event_hub_endpoints ⇒ Hash{String => EventHubProperties}

endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.

Returns:



35
36
37
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 35

def event_hub_endpoints
  @event_hub_endpoints
end

#features ⇒ Capabilities

IoT hub. Possible values include: ‘None’, ‘DeviceManagement’

Returns:

  • (Capabilities) —

    The capabilities and features enabled for the



68
69
70
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 68

def features
  @features
end

#host_name ⇒ String

Returns The name of the host.

Returns:

  • (String) —

    The name of the host.



29
30
31
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 29

def host_name
  @host_name
end

#ip_filter_rules ⇒ Array<IpFilterRule>

Returns The IP filter rules.

Returns:



20
21
22
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 20

def ip_filter_rules
  @ip_filter_rules
end

#locations ⇒ Array<IotHubLocationDescription>

location for iot hub

Returns:



72
73
74
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 72

def locations
  @locations
end

#messaging_endpoints ⇒ Hash{String => MessagingEndpointProperties}

endpoint properties for the file upload notification queue.

Returns:



51
52
53
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 51

def messaging_endpoints
  @messaging_endpoints
end

#provisioning_state ⇒ String

Returns The provisioning state.

Returns:

  • (String) —

    The provisioning state.



23
24
25
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 23

def provisioning_state
  @provisioning_state
end

#routing ⇒ RoutingProperties

Returns:



38
39
40
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 38

def routing
  @routing
end

#state ⇒ String

Returns The hub state.

Returns:

  • (String) —

    The hub state.



26
27
28
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 26

def state
  @state
end

#storage_endpoints ⇒ Hash{String => StorageEndpointProperties}

Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.

Returns:



47
48
49
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 47

def storage_endpoints
  @storage_endpoints
end

Class Method Details

.mapper ⇒ Object

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



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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 79

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'IotHubProperties',
    type: {
      name: 'Composite',
      class_name: 'IotHubProperties',
      model_properties: {
        authorization_policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'authorizationPolicies',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SharedAccessSignatureAuthorizationRuleElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SharedAccessSignatureAuthorizationRule'
                }
            }
          }
        },
        ip_filter_rules: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ipFilterRules',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'IpFilterRuleElementType',
                type: {
                  name: 'Composite',
                  class_name: 'IpFilterRule'
                }
            }
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'provisioningState',
          type: {
            name: 'String'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'state',
          type: {
            name: 'String'
          }
        },
        host_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'hostName',
          type: {
            name: 'String'
          }
        },
        event_hub_endpoints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'eventHubEndpoints',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'EventHubPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'EventHubProperties'
                }
            }
          }
        },
        routing: {
          client_side_validation: true,
          required: false,
          serialized_name: 'routing',
          type: {
            name: 'Composite',
            class_name: 'RoutingProperties'
          }
        },
        storage_endpoints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'storageEndpoints',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StorageEndpointPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'StorageEndpointProperties'
                }
            }
          }
        },
        messaging_endpoints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'messagingEndpoints',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MessagingEndpointPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MessagingEndpointProperties'
                }
            }
          }
        },
        enable_file_upload_notifications: {
          client_side_validation: true,
          required: false,
          serialized_name: 'enableFileUploadNotifications',
          type: {
            name: 'Boolean'
          }
        },
        cloud_to_device: {
          client_side_validation: true,
          required: false,
          serialized_name: 'cloudToDevice',
          type: {
            name: 'Composite',
            class_name: 'CloudToDeviceProperties'
          }
        },
        comments: {
          client_side_validation: true,
          required: false,
          serialized_name: 'comments',
          type: {
            name: 'String'
          }
        },
        device_streams: {
          client_side_validation: true,
          required: false,
          serialized_name: 'deviceStreams',
          type: {
            name: 'Composite',
            class_name: 'IotHubPropertiesDeviceStreams'
          }
        },
        features: {
          client_side_validation: true,
          required: false,
          serialized_name: 'features',
          type: {
            name: 'String'
          }
        },
        locations: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'locations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'IotHubLocationDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'IotHubLocationDescription'
                }
            }
          }
        }
      }
    }
  }
end