Class: Azure::ARM::IotHub::Models::IotHubProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb

Overview

The Iot Hub properties.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#authorization_policies ⇒ Array<SharedAccessSignatureAuthorizationRule>

authorization rules.

Returns:



17
18
19
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 17

def authorization_policies
  @authorization_policies
end

#cloud_to_device ⇒ CloudToDeviceProperties

Returns:



44
45
46
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 44

def cloud_to_device
  @cloud_to_device
end

#comments ⇒ String

Returns The comments.

Returns:

  • (String) —

    The comments.



47
48
49
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 47

def comments
  @comments
end

#enable_file_upload_notifications ⇒ Boolean

notification should be enabled. This is optional at iot hub level. When enabled upload notifications will be available.

Returns:

  • (Boolean) —

    The flag which indicates whether file upload



41
42
43
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 41

def enable_file_upload_notifications
  @enable_file_upload_notifications
end

#event_hub_endpoints ⇒ Hash{String => EventHubProperties}

properties.

Returns:



27
28
29
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 27

def event_hub_endpoints
  @event_hub_endpoints
end

#features ⇒ Capabilities

enabled for the Hub. Possible values include: ‘None’, ‘DeviceManagement’

Returns:

  • (Capabilities) —

    The Capabilities/Features that need to be



55
56
57
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 55

def features
  @features
end

#host_name ⇒ String

Returns The name of the host.

Returns:

  • (String) —

    The name of the host.



23
24
25
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 23

def host_name
  @host_name
end

#ip_filter_rules ⇒ Array<IpFilterRule>

Returns The IP filter rules.

Returns:



20
21
22
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 20

def ip_filter_rules
  @ip_filter_rules
end

#messaging_endpoints ⇒ Hash{String => MessagingEndpointProperties}

messaging end points configured.

Returns:



36
37
38
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 36

def messaging_endpoints
  @messaging_endpoints
end

#operations_monitoring_properties ⇒ OperationsMonitoringProperties

Returns:



50
51
52
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 50

def operations_monitoring_properties
  @operations_monitoring_properties
end

#storage_endpoints ⇒ Hash{String => StorageEndpointProperties}

storage end points where files can be uploaded. Currently only one storage account can be configured.

Returns:



32
33
34
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 32

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.



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
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
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 62

def self.mapper()
  {
    required: false,
    serialized_name: 'IotHubProperties',
    type: {
      name: 'Composite',
      class_name: 'IotHubProperties',
      model_properties: {
        authorization_policies: {
          required: false,
          serialized_name: 'authorizationPolicies',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'SharedAccessSignatureAuthorizationRuleElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SharedAccessSignatureAuthorizationRule'
                }
            }
          }
        },
        ip_filter_rules: {
          required: false,
          serialized_name: 'ipFilterRules',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'IpFilterRuleElementType',
                type: {
                  name: 'Composite',
                  class_name: 'IpFilterRule'
                }
            }
          }
        },
        host_name: {
          required: false,
          serialized_name: 'hostName',
          type: {
            name: 'String'
          }
        },
        event_hub_endpoints: {
          required: false,
          serialized_name: 'eventHubEndpoints',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'EventHubPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'EventHubProperties'
                }
            }
          }
        },
        storage_endpoints: {
          required: false,
          serialized_name: 'storageEndpoints',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'StorageEndpointPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'StorageEndpointProperties'
                }
            }
          }
        },
        messaging_endpoints: {
          required: false,
          serialized_name: 'messagingEndpoints',
          type: {
            name: 'Dictionary',
            value: {
                required: false,
                serialized_name: 'MessagingEndpointPropertiesElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MessagingEndpointProperties'
                }
            }
          }
        },
        enable_file_upload_notifications: {
          required: false,
          serialized_name: 'enableFileUploadNotifications',
          type: {
            name: 'Boolean'
          }
        },
        cloud_to_device: {
          required: false,
          serialized_name: 'cloudToDevice',
          type: {
            name: 'Composite',
            class_name: 'CloudToDeviceProperties'
          }
        },
        comments: {
          required: false,
          serialized_name: 'comments',
          type: {
            name: 'String'
          }
        },
        operations_monitoring_properties: {
          required: false,
          serialized_name: 'operationsMonitoringProperties',
          type: {
            name: 'Composite',
            class_name: 'OperationsMonitoringProperties'
          }
        },
        features: {
          required: false,
          serialized_name: 'features',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end