azure_mgmt_iot_hub 0.8.0 → 0.9.0

data/lib/generated/azure_mgmt_iot_hub/models/iot_hub_properties.rb

@@ -6,52 +6,58 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The Iot Hub properties.
+    # The properties of an IoT hub.
     #
     class IotHubProperties
 
       include MsRestAzure
 
-      # @return [Array<SharedAccessSignatureAuthorizationRule>] The
-      # authorization rules.
+      # @return [Array<SharedAccessSignatureAuthorizationRule>] The shared
+      # access policies you can use to secure a connection to the IoT hub.
       attr_accessor :authorization_policies
 
       # @return [Array<IpFilterRule>] The IP filter rules.
       attr_accessor :ip_filter_rules
 
+      # @return [String] The provisioning state.
+      attr_accessor :provisioning_state
+
       # @return [String] The name of the host.
       attr_accessor :host_name
 
-      # @return [Hash{String => EventHubProperties}] The event hub endpoint
-      # properties.
+      # @return [Hash{String => EventHubProperties}] The Event Hub-compatible
+      # 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.
       attr_accessor :event_hub_endpoints
 
-      # @return [Hash{String => StorageEndpointProperties}] The list of storage
-      # end points where files can be uploaded. Currently only one storage
-      # account can be configured.
+      # @return [Hash{String => StorageEndpointProperties}] The list of Azure
+      # 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.
       attr_accessor :storage_endpoints
 
-      # @return [Hash{String => MessagingEndpointProperties}] The list of
-      # messaging end points configured.
+      # @return [Hash{String => MessagingEndpointProperties}] The messaging
+      # endpoint properties for the file upload notification queue.
       attr_accessor :messaging_endpoints
 
-      # @return [Boolean] The flag which indicates whether file upload
-      # notification should be enabled. This is optional at iot hub level. When
-      # enabled upload notifications will be available.
+      # @return [Boolean] If True, file upload notifications are enabled.
       attr_accessor :enable_file_upload_notifications
 
       # @return [CloudToDeviceProperties]
       attr_accessor :cloud_to_device
 
-      # @return [String] The comments.
+      # @return [String] Comments.
       attr_accessor :comments
 
       # @return [OperationsMonitoringProperties]
       attr_accessor :operations_monitoring_properties
 
-      # @return [Capabilities] The Capabilities/Features that need to be
-      # enabled for the Hub. Possible values include: 'None',
-      # 'DeviceManagement'
+      # @return [Capabilities] The capabilities and features enabled for the
+      # IoT hub. Possible values include: 'None', 'DeviceManagement'
       attr_accessor :features
 
 
@@ -97,8 +103,17 @@ module Azure::ARM::IotHub
                   }
                 }
               },
+              provisioning_state: {
+                required: false,
+                read_only: true,
+                serialized_name: 'provisioningState',
+                type: {
+                  name: 'String'
+                }
+              },
               host_name: {
                 required: false,
+                read_only: true,
                 serialized_name: 'hostName',
                 type: {
                   name: 'String'

data/lib/generated/azure_mgmt_iot_hub/models/iot_hub_quota_metric_info.rb

@@ -6,7 +6,7 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The properties related to quota metrics.
+    # Quota metrics properties.
     #
     class IotHubQuotaMetricInfo
 
@@ -36,6 +36,7 @@ module Azure::ARM::IotHub
             model_properties: {
               name: {
                 required: false,
+                read_only: true,
                 serialized_name: 'Name',
                 type: {
                   name: 'String'
@@ -43,6 +44,7 @@ module Azure::ARM::IotHub
               },
               current_value: {
                 required: false,
+                read_only: true,
                 serialized_name: 'CurrentValue',
                 type: {
                   name: 'Number'
@@ -50,6 +52,7 @@ module Azure::ARM::IotHub
               },
               max_value: {
                 required: false,
+                read_only: true,
                 serialized_name: 'MaxValue',
                 type: {
                   name: 'Number'

data/lib/generated/azure_mgmt_iot_hub/models/iot_hub_quota_metric_info_list_result.rb

@@ -6,14 +6,15 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The list of IotHubQuotaMetricInfo objects with a next link.
+    # The JSON-serialized array of IotHubQuotaMetricInfo objects with a next
+    # link.
     #
     class IotHubQuotaMetricInfoListResult
 
       include MsRestAzure
 
-      # @return [Array<IotHubQuotaMetricInfo>] The list of
-      # IotHubQuotaMetricInfo.
+      # @return [Array<IotHubQuotaMetricInfo>] The array of quota metrics
+      # objects.
       attr_accessor :value
 
       # @return [String] The next link.

data/lib/generated/azure_mgmt_iot_hub/models/iot_hub_sku_description.rb

@@ -6,7 +6,7 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The properties related to the Sku.
+    # SKU properties.
     #
     class IotHubSkuDescription
 
@@ -43,7 +43,7 @@ module Azure::ARM::IotHub
                 }
               },
               sku: {
-                required: false,
+                required: true,
                 serialized_name: 'sku',
                 type: {
                   name: 'Composite',
@@ -51,7 +51,7 @@ module Azure::ARM::IotHub
                 }
               },
               capacity: {
-                required: false,
+                required: true,
                 serialized_name: 'capacity',
                 type: {
                   name: 'Composite',

data/lib/generated/azure_mgmt_iot_hub/models/iot_hub_sku_description_list_result.rb

@@ -6,13 +6,15 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The list of IotHubSkuDescription objects with a next link.
+    # The JSON-serialized array of IotHubSkuDescription objects with a next
+    # link.
     #
     class IotHubSkuDescriptionListResult
 
       include MsRestAzure
 
-      # @return [Array<IotHubSkuDescription>] The list of IotHubSkuDescription.
+      # @return [Array<IotHubSkuDescription>] The array of
+      # IotHubSkuDescription.
       attr_accessor :value
 
       # @return [String] The next link.

data/lib/generated/azure_mgmt_iot_hub/models/iot_hub_sku_info.rb

@@ -6,23 +6,22 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The Sku related information for the hub.
+    # Information about the SKU of the IoT hub.
     #
     class IotHubSkuInfo
 
       include MsRestAzure
 
-      # @return [IotHubSku] The name of the Sku. Possible values include: 'F1',
+      # @return [IotHubSku] The name of the SKU. Possible values include: 'F1',
       # 'S1', 'S2', 'S3'
       attr_accessor :name
 
-      # @return [IotHubSkuTier] The tier. Possible values include: 'Free',
-      # 'Standard'
+      # @return [IotHubSkuTier] The billing tier for the IoT hub. Possible
+      # values include: 'Free', 'Standard'
       attr_accessor :tier
 
-      # @return [Integer] The number of units being provisioned. Range of
-      # values [For F1: 1-1, S1: 1-200, S2: 1-200, S3: 1-10]. To go above this
-      # range, call support.
+      # @return [Integer] The number of provisioned IoT Hub units. See:
+      # https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
       attr_accessor :capacity
 
 
@@ -39,7 +38,7 @@ module Azure::ARM::IotHub
             class_name: 'IotHubSkuInfo',
             model_properties: {
               name: {
-                required: false,
+                required: true,
                 serialized_name: 'name',
                 type: {
                   name: 'String'
@@ -55,7 +54,7 @@ module Azure::ARM::IotHub
                 }
               },
               capacity: {
-                required: false,
+                required: true,
                 serialized_name: 'capacity',
                 type: {
                   name: 'Number'

data/lib/generated/azure_mgmt_iot_hub/models/ip_filter_rule.rb

@@ -6,7 +6,7 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # IP filter Rule
+    # The IP filter rules for the IoT hub.
     #
     class IpFilterRule
 
@@ -15,12 +15,12 @@ module Azure::ARM::IotHub
       # @return [String] The name of the IP filter rule.
       attr_accessor :filter_name
 
-      # @return [IpFilterActionType] The action desired - accept or reject.
-      # Possible values include: 'Accept', 'Reject'
+      # @return [IpFilterActionType] The desired action for requests captured
+      # by this rule. Possible values include: 'Accept', 'Reject'
       attr_accessor :action
 
-      # @return [String] A string containing the IPAddress/range in CIDR
-      # notation.
+      # @return [String] A string that contains the IP address range in CIDR
+      # notation for the rule.
       attr_accessor :ip_mask
 
 

data/lib/generated/azure_mgmt_iot_hub/models/job_response.rb

@@ -6,7 +6,7 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The properties describing a Job Response.
+    # The properties of the Job Response object.
     #
     class JobResponse
 
@@ -15,33 +15,30 @@ module Azure::ARM::IotHub
       # @return [String] The job identifier.
       attr_accessor :job_id
 
-      # @return [DateTime] Start time of the Job.
+      # @return [DateTime] The start time of the Job.
       attr_accessor :start_time_utc
 
-      # @return [DateTime] Represents the time the job stopped processing.
+      # @return [DateTime] The time the job stopped processing.
       attr_accessor :end_time_utc
 
-      # @return [JobType] The type of job to execute. Possible values include:
+      # @return [JobType] The type of the job. Possible values include:
       # 'unknown', 'export', 'import', 'backup', 'readDeviceProperties',
       # 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice',
       # 'factoryResetDevice', 'firmwareUpdate'
       attr_accessor :type
 
-      # @return [JobStatus] Status of the Job. Possible values include:
+      # @return [JobStatus] The status of the job. Possible values include:
       # 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled'
       attr_accessor :status
 
-      # @return [String] If status == failure, this represents a string
-      # containing the reason.
+      # @return [String] If status == failed, this string containing the reason
+      # for the failure.
       attr_accessor :failure_reason
 
       # @return [String] The status message for the job.
       attr_accessor :status_message
 
-      # @return [String] The deviceId related to this response.
-      attr_accessor :device_id
-
-      # @return [String] The jobId of the parent job, if any.
+      # @return [String] The job identifier of the parent job, if any.
       attr_accessor :parent_job_id
 
 
@@ -59,6 +56,7 @@ module Azure::ARM::IotHub
             model_properties: {
               job_id: {
                 required: false,
+                read_only: true,
                 serialized_name: 'jobId',
                 type: {
                   name: 'String'
@@ -66,20 +64,23 @@ module Azure::ARM::IotHub
               },
               start_time_utc: {
                 required: false,
+                read_only: true,
                 serialized_name: 'startTimeUtc',
                 type: {
-                  name: 'DateTime'
+                  name: 'DateTimeRfc1123'
                 }
               },
               end_time_utc: {
                 required: false,
+                read_only: true,
                 serialized_name: 'endTimeUtc',
                 type: {
-                  name: 'DateTime'
+                  name: 'DateTimeRfc1123'
                 }
               },
               type: {
                 required: false,
+                read_only: true,
                 serialized_name: 'type',
                 type: {
                   name: 'String'
@@ -87,6 +88,7 @@ module Azure::ARM::IotHub
               },
               status: {
                 required: false,
+                read_only: true,
                 serialized_name: 'status',
                 type: {
                   name: 'Enum',
@@ -95,6 +97,7 @@ module Azure::ARM::IotHub
               },
               failure_reason: {
                 required: false,
+                read_only: true,
                 serialized_name: 'failureReason',
                 type: {
                   name: 'String'
@@ -102,20 +105,15 @@ module Azure::ARM::IotHub
               },
               status_message: {
                 required: false,
+                read_only: true,
                 serialized_name: 'statusMessage',
                 type: {
                   name: 'String'
                 }
               },
-              device_id: {
-                required: false,
-                serialized_name: 'deviceId',
-                type: {
-                  name: 'String'
-                }
-              },
               parent_job_id: {
                 required: false,
+                read_only: true,
                 serialized_name: 'parentJobId',
                 type: {
                   name: 'String'

data/lib/generated/azure_mgmt_iot_hub/models/job_response_list_result.rb

@@ -6,13 +6,13 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The list of JobResponse objects with a next link.
+    # The JSON-serialized array of JobResponse objects with a next link.
     #
     class JobResponseListResult
 
       include MsRestAzure
 
-      # @return [Array<JobResponse>] The list of JobResponse.
+      # @return [Array<JobResponse>] The array of JobResponse objects.
       attr_accessor :value
 
       # @return [String] The next link.

data/lib/generated/azure_mgmt_iot_hub/models/messaging_endpoint_properties.rb

@@ -6,21 +6,24 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # The properties of the Messaging Endpoints used by this IoT Hub.
+    # The properties of the messaging endpoints used by this IoT hub.
     #
     class MessagingEndpointProperties
 
       include MsRestAzure
 
-      # @return [Duration] The lock duration. Range: 5 Sec (PT5S) - 5 Min
-      # (PT5M).
+      # @return [Duration] The lock duration. See:
+      # https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.
       attr_accessor :lock_duration_as_iso8601
 
-      # @return [Duration] The time to live. Range: 1 Min (PT1M) - 2 Days
-      # (P2D).
+      # @return [Duration] The period of time for which a message is available
+      # to consume before it is expired by the IoT hub. See:
+      # https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.
       attr_accessor :ttl_as_iso8601
 
-      # @return [Integer] The max delivery count. Range: 1-100.
+      # @return [Integer] The number of times the IoT hub attempts to deliver a
+      # message. See:
+      # https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-file-upload.
       attr_accessor :max_delivery_count
 
 

data/lib/generated/azure_mgmt_iot_hub/models/operation_inputs.rb

@@ -6,13 +6,13 @@
 module Azure::ARM::IotHub
   module Models
     #
-    # OperationInputs.
+    # Input values.
     #
     class OperationInputs
 
       include MsRestAzure
 
-      # @return [String] The name of the iot hub.
+      # @return [String] The name of the IoT hub to check.
       attr_accessor :name