Class: Azure::IotHub::Mgmt::V2016_02_03::Models::IotHubProperties
- Inherits:
-
Object
- Object
- Azure::IotHub::Mgmt::V2016_02_03::Models::IotHubProperties
- Includes:
- MsRestAzure
- Defined in:
- lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb
Overview
The properties of an IoT hub.
Instance Attribute Summary collapse
-
#authorization_policies ⇒ Array<SharedAccessSignatureAuthorizationRule>
access policies you can use to secure a connection to the IoT hub.
- #cloud_to_device ⇒ CloudToDeviceProperties
-
#comments ⇒ String
Comments.
-
#enable_file_upload_notifications ⇒ Boolean
If True, file upload notifications are enabled.
-
#event_hub_endpoints ⇒ Hash{String => EventHubProperties}
endpoint properties.
-
#features ⇒ Capabilities
IoT hub.
-
#host_name ⇒ String
The name of the host.
-
#ip_filter_rules ⇒ Array<IpFilterRule>
The IP filter rules.
-
#messaging_endpoints ⇒ Hash{String => MessagingEndpointProperties}
endpoint properties for the file upload notification queue.
- #operations_monitoring_properties ⇒ OperationsMonitoringProperties
-
#provisioning_state ⇒ String
The provisioning state.
-
#storage_endpoints ⇒ Hash{String => StorageEndpointProperties}
Storage endpoints where you can upload files.
Class Method Summary collapse
-
.mapper ⇒ Object
Mapper for IotHubProperties class as Ruby Hash.
Instance Attribute Details
#authorization_policies ⇒ Array<SharedAccessSignatureAuthorizationRule>
access policies you can use to secure a connection to the IoT hub.
17 18 19 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 17 def @authorization_policies end |
#cloud_to_device ⇒ CloudToDeviceProperties
51 52 53 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 51 def cloud_to_device @cloud_to_device end |
#comments ⇒ String
Returns Comments.
54 55 56 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 54 def comments @comments end |
#enable_file_upload_notifications ⇒ Boolean
Returns If True, file upload notifications are enabled.
48 49 50 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 48 def enable_file_upload_notifications @enable_file_upload_notifications end |
#event_hub_endpoints ⇒ Hash{String => EventHubProperties}
endpoint properties. The possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have to be present in the dictionary while making create or update calls for the IoT hub.
32 33 34 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 32 def event_hub_endpoints @event_hub_endpoints end |
#features ⇒ Capabilities
IoT hub. Possible values include: ‘None’, ‘DeviceManagement’
61 62 63 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 61 def features @features end |
#host_name ⇒ String
Returns The name of the host.
26 27 28 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 26 def host_name @host_name end |
#ip_filter_rules ⇒ Array<IpFilterRule>
Returns The IP filter rules.
20 21 22 |
# File 'lib/2016-02-03/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}
endpoint properties for the file upload notification queue.
45 46 47 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 45 def messaging_endpoints @messaging_endpoints end |
#operations_monitoring_properties ⇒ OperationsMonitoringProperties
57 58 59 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 57 def operations_monitoring_properties @operations_monitoring_properties end |
#provisioning_state ⇒ String
Returns The provisioning state.
23 24 25 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 23 def provisioning_state @provisioning_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.
41 42 43 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 41 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.
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 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 |
# File 'lib/2016-02-03/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb', line 68 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' } }, 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' } } } }, 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' } }, operations_monitoring_properties: { client_side_validation: true, required: false, serialized_name: 'operationsMonitoringProperties', type: { name: 'Composite', class_name: 'OperationsMonitoringProperties' } }, features: { client_side_validation: true, required: false, serialized_name: 'features', type: { name: 'String' } } } } } end |