diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationClient.cs index b8300aa00dec..aedf3563cd98 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationClient.cs @@ -33,8 +33,8 @@ internal ConfigurationClient(ClientDiagnostics clientDiagnostics, HttpPipeline p _pipeline = pipeline; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. + /// Get a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. /// The cancellation token to use. public virtual async Task> GetAsync(string id, CancellationToken cancellationToken = default) { @@ -51,8 +51,8 @@ public virtual async Task> GetAsync(string id, Cance } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. + /// Get a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. /// The cancellation token to use. public virtual Response Get(string id, CancellationToken cancellationToken = default) { @@ -69,10 +69,10 @@ public virtual Response Get(string id, CancellationToken canc } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The Configuration to use. - /// The String to use. + /// Create or update a configuration on IoT Hub for automatic device/module management. Configuration Id and Content cannot be updated. + /// The unique identifier of the configuration. + /// The configuration to be created or updated. + /// A string representing a weak ETag for configuration, as per RFC7232. Should not be set when creating a configuration, but may be set when updating a configuration. /// The cancellation token to use. public virtual async Task> CreateOrUpdateAsync(string id, TwinConfiguration configuration, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -89,10 +89,10 @@ public virtual async Task> CreateOrUpdateAsync(strin } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The Configuration to use. - /// The String to use. + /// Create or update a configuration on IoT Hub for automatic device/module management. Configuration Id and Content cannot be updated. + /// The unique identifier of the configuration. + /// The configuration to be created or updated. + /// A string representing a weak ETag for configuration, as per RFC7232. Should not be set when creating a configuration, but may be set when updating a configuration. /// The cancellation token to use. public virtual Response CreateOrUpdate(string id, TwinConfiguration configuration, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -109,9 +109,9 @@ public virtual Response CreateOrUpdate(string id, TwinConfigu } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The String to use. + /// Delete a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. + /// A string representing a weak ETag for configuration, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the configuration has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public virtual async Task DeleteAsync(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -128,9 +128,9 @@ public virtual async Task DeleteAsync(string id, string ifMatch = null } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The String to use. + /// Delete a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. + /// A string representing a weak ETag for configuration, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the configuration has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public virtual Response Delete(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -147,8 +147,8 @@ public virtual Response Delete(string id, string ifMatch = null, CancellationTok } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The Integer to use. + /// Get multiple configurations on IoT Hub for automatic device/module management. + /// Number of configurations to retrieve. TODO: Ask service team if this value can be overriden if too large. /// The cancellation token to use. public virtual async Task>> GetConfigurationsAsync(int? top = null, CancellationToken cancellationToken = default) { @@ -165,8 +165,8 @@ public virtual async Task>> GetConfigu } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The Integer to use. + /// Get multiple configurations on IoT Hub for automatic device/module management. + /// Number of configurations to retrieve. TODO: Ask service team if this value can be overriden if too large. /// The cancellation token to use. public virtual Response> GetConfigurations(int? top = null, CancellationToken cancellationToken = default) { @@ -183,8 +183,8 @@ public virtual Response> GetConfigurations(int? } } - /// Validates the target condition query and custom metric queries for a configuration. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The ConfigurationQueriesTestInput to use. + /// Validate the target condition and custom metric queries for a configuration on IoT Hub. + /// Configuration query for target condition or custom metrics. /// The cancellation token to use. public virtual async Task> TestQueriesAsync(ConfigurationQueriesTestInput input, CancellationToken cancellationToken = default) { @@ -201,8 +201,8 @@ public virtual async Task> TestQuerie } } - /// Validates the target condition query and custom metric queries for a configuration. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The ConfigurationQueriesTestInput to use. + /// Validate the target condition and custom metric queries for a configuration on IoT Hub. + /// Configuration query for target condition or custom metrics. /// The cancellation token to use. public virtual Response TestQueries(ConfigurationQueriesTestInput input, CancellationToken cancellationToken = default) { @@ -219,8 +219,8 @@ public virtual Response TestQueries(Configurat } } - /// Applies the provided configuration content to the specified edge device. Configuration content must have modules content For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Apply the provided configuration content to the specified edge device. + /// The unique identifier of the device. /// Configuration Content. /// The cancellation token to use. public virtual async Task> ApplyOnEdgeDeviceAsync(string id, ConfigurationContent content, CancellationToken cancellationToken = default) @@ -238,8 +238,8 @@ public virtual async Task> ApplyOnEdgeDeviceAsync(string id, Co } } - /// Applies the provided configuration content to the specified edge device. Configuration content must have modules content For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Apply the provided configuration content to the specified edge device. + /// The unique identifier of the device. /// Configuration Content. /// The cancellation token to use. public virtual Response ApplyOnEdgeDevice(string id, ConfigurationContent content, CancellationToken cancellationToken = default) diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationRestClient.cs index 344b957a34d0..77fd5b7b947f 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/ConfigurationRestClient.cs @@ -56,8 +56,8 @@ internal HttpMessage CreateGetRequest(string id) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. + /// Get a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. /// The cancellation token to use. public async ValueTask> GetAsync(string id, CancellationToken cancellationToken = default) { @@ -89,8 +89,8 @@ public async ValueTask> GetAsync(string id, Cancella } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. + /// Get a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. /// The cancellation token to use. public Response Get(string id, CancellationToken cancellationToken = default) { @@ -144,10 +144,10 @@ internal HttpMessage CreateCreateOrUpdateRequest(string id, TwinConfiguration co return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The Configuration to use. - /// The String to use. + /// Create or update a configuration on IoT Hub for automatic device/module management. Configuration Id and Content cannot be updated. + /// The unique identifier of the configuration. + /// The configuration to be created or updated. + /// A string representing a weak ETag for configuration, as per RFC7232. Should not be set when creating a configuration, but may be set when updating a configuration. /// The cancellation token to use. public async ValueTask> CreateOrUpdateAsync(string id, TwinConfiguration configuration, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -184,10 +184,10 @@ public async ValueTask> CreateOrUpdateAsync(string i } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The Configuration to use. - /// The String to use. + /// Create or update a configuration on IoT Hub for automatic device/module management. Configuration Id and Content cannot be updated. + /// The unique identifier of the configuration. + /// The configuration to be created or updated. + /// A string representing a weak ETag for configuration, as per RFC7232. Should not be set when creating a configuration, but may be set when updating a configuration. /// The cancellation token to use. public Response CreateOrUpdate(string id, TwinConfiguration configuration, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -242,9 +242,9 @@ internal HttpMessage CreateDeleteRequest(string id, string ifMatch) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The String to use. + /// Delete a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. + /// A string representing a weak ETag for configuration, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the configuration has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public async ValueTask DeleteAsync(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -264,9 +264,9 @@ public async ValueTask DeleteAsync(string id, string ifMatch = null, C } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The String to use. - /// The String to use. + /// Delete a configuration on IoT Hub for automatic device/module management. + /// The unique identifier of the configuration. + /// A string representing a weak ETag for configuration, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the configuration has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public Response Delete(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -303,8 +303,8 @@ internal HttpMessage CreateGetConfigurationsRequest(int? top) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The Integer to use. + /// Get multiple configurations on IoT Hub for automatic device/module management. + /// Number of configurations to retrieve. TODO: Ask service team if this value can be overriden if too large. /// The cancellation token to use. public async ValueTask>> GetConfigurationsAsync(int? top = null, CancellationToken cancellationToken = default) { @@ -343,8 +343,8 @@ public async ValueTask>> GetConfigurat } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The Integer to use. + /// Get multiple configurations on IoT Hub for automatic device/module management. + /// Number of configurations to retrieve. TODO: Ask service team if this value can be overriden if too large. /// The cancellation token to use. public Response> GetConfigurations(int? top = null, CancellationToken cancellationToken = default) { @@ -400,8 +400,8 @@ internal HttpMessage CreateTestQueriesRequest(ConfigurationQueriesTestInput inpu return message; } - /// Validates the target condition query and custom metric queries for a configuration. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The ConfigurationQueriesTestInput to use. + /// Validate the target condition and custom metric queries for a configuration on IoT Hub. + /// Configuration query for target condition or custom metrics. /// The cancellation token to use. public async ValueTask> TestQueriesAsync(ConfigurationQueriesTestInput input, CancellationToken cancellationToken = default) { @@ -433,8 +433,8 @@ public async ValueTask> TestQueriesAs } } - /// Validates the target condition query and custom metric queries for a configuration. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The ConfigurationQueriesTestInput to use. + /// Validate the target condition and custom metric queries for a configuration on IoT Hub. + /// Configuration query for target condition or custom metrics. /// The cancellation token to use. public Response TestQueries(ConfigurationQueriesTestInput input, CancellationToken cancellationToken = default) { @@ -485,8 +485,8 @@ internal HttpMessage CreateApplyOnEdgeDeviceRequest(string id, ConfigurationCont return message; } - /// Applies the provided configuration content to the specified edge device. Configuration content must have modules content For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Apply the provided configuration content to the specified edge device. + /// The unique identifier of the device. /// Configuration Content. /// The cancellation token to use. public async ValueTask> ApplyOnEdgeDeviceAsync(string id, ConfigurationContent content, CancellationToken cancellationToken = default) @@ -525,8 +525,8 @@ public async ValueTask> ApplyOnEdgeDeviceAsync(string id, Confi } } - /// Applies the provided configuration content to the specified edge device. Configuration content must have modules content For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Apply the provided configuration content to the specified edge device. + /// The unique identifier of the device. /// Configuration Content. /// The cancellation token to use. public Response ApplyOnEdgeDevice(string id, ConfigurationContent content, CancellationToken cancellationToken = default) diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodClient.cs index 74d4498fad59..ee0d0a0baebb 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodClient.cs @@ -33,8 +33,8 @@ internal DeviceMethodClient(ClientDiagnostics clientDiagnostics, HttpPipeline pi } /// Invoke a direct method on a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// Parameters to execute a direct method on the device. /// The cancellation token to use. public virtual async Task> InvokeDeviceMethodAsync(string deviceId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { @@ -52,8 +52,8 @@ public virtual async Task> InvokeDeviceMetho } /// Invoke a direct method on a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// Parameters to execute a direct method on the device. /// The cancellation token to use. public virtual Response InvokeDeviceMethod(string deviceId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { @@ -71,9 +71,9 @@ public virtual Response InvokeDeviceMethod(string dev } /// Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// Parameters to execute a direct method on the module. /// The cancellation token to use. public virtual async Task> InvokeModuleMethodAsync(string deviceId, string moduleId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { @@ -91,9 +91,9 @@ public virtual async Task> InvokeModuleMetho } /// Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// Parameters to execute a direct method on the module. /// The cancellation token to use. public virtual Response InvokeModuleMethod(string deviceId, string moduleId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodRestClient.cs index 339bff491ff6..d0e8f697aa85 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DeviceMethodRestClient.cs @@ -61,8 +61,8 @@ internal HttpMessage CreateInvokeDeviceMethodRequest(string deviceId, CloudToDev } /// Invoke a direct method on a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// Parameters to execute a direct method on the device. /// The cancellation token to use. public async ValueTask> InvokeDeviceMethodAsync(string deviceId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { @@ -99,8 +99,8 @@ public async ValueTask> InvokeDeviceMethodAs } /// Invoke a direct method on a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// Parameters to execute a direct method on the device. /// The cancellation token to use. public Response InvokeDeviceMethod(string deviceId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { @@ -158,9 +158,9 @@ internal HttpMessage CreateInvokeModuleMethodRequest(string deviceId, string mod } /// Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// Parameters to execute a direct method on the module. /// The cancellation token to use. public async ValueTask> InvokeModuleMethodAsync(string deviceId, string moduleId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { @@ -201,9 +201,9 @@ public async ValueTask> InvokeModuleMethodAs } /// Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information. - /// The String to use. - /// The String to use. - /// The CloudToDeviceMethod to use. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// Parameters to execute a direct method on the module. /// The cancellation token to use. public Response InvokeModuleMethod(string deviceId, string moduleId, CloudToDeviceMethod directMethodRequest, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinClient.cs index 584153fb16e9..0cbbef18b64b 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinClient.cs @@ -32,8 +32,8 @@ internal DigitalTwinClient(ClientDiagnostics clientDiagnostics, HttpPipeline pip _pipeline = pipeline; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the list of interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The cancellation token to use. public virtual async Task> GetComponentsAsync(string digitalTwinId, CancellationToken cancellationToken = default) { @@ -50,8 +50,8 @@ public virtual async Task> GetComponentsAsync(st } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the list of interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The cancellation token to use. public virtual Response GetComponents(string digitalTwinId, CancellationToken cancellationToken = default) { @@ -68,10 +68,10 @@ public virtual Response GetComponents(string digitalTwinI } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. - /// Multiple interfaces desired properties to update. - /// The String to use. + /// Updates desired properties of multiple interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// The JSON representation of the update patch. + /// A string representing a weak ETag for digital twin, as per RFC7232. /// The cancellation token to use. public virtual async Task> UpdateComponentAsync(string digitalTwinId, DigitalTwinInterfacesPatch interfacesPatchInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -88,10 +88,10 @@ public virtual async Task> UpdateComponentAsync( } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. - /// Multiple interfaces desired properties to update. - /// The String to use. + /// Updates desired properties of multiple interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// The JSON representation of the update patch. + /// A string representing a weak ETag for digital twin, as per RFC7232. /// The cancellation token to use. public virtual Response UpdateComponent(string digitalTwinId, DigitalTwinInterfacesPatch interfacesPatchInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -108,8 +108,8 @@ public virtual Response UpdateComponent(string digitalTwi } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the interface. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The interface name. /// The cancellation token to use. public virtual async Task> GetComponentAsync(string digitalTwinId, string interfaceName, CancellationToken cancellationToken = default) @@ -127,8 +127,8 @@ public virtual async Task> GetComponentAsync(str } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the interface. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The interface name. /// The cancellation token to use. public virtual Response GetComponent(string digitalTwinId, string interfaceName, CancellationToken cancellationToken = default) @@ -146,7 +146,13 @@ public virtual Response GetComponent(string digitalTwinId } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// + /// Returns a DigitalTwin model definition for the given id. + /// + /// If "expand" is present in the query parameters and id is for a device capability model then it returns + /// + /// the capability metamodel with expanded interface definitions. + /// /// Model id Ex: <example>urn:contoso:TemperatureSensor:1</example>. /// /// Indicates whether to expand the device capability model's interface definitions inline or not. @@ -169,7 +175,13 @@ public virtual async Task> GetDigitalTwinModelAsync(string mode } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// + /// Returns a DigitalTwin model definition for the given id. + /// + /// If "expand" is present in the query parameters and id is for a device capability model then it returns + /// + /// the capability metamodel with expanded interface definitions. + /// /// Model id Ex: <example>urn:contoso:TemperatureSensor:1</example>. /// /// Indicates whether to expand the device capability model's interface definitions inline or not. diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinRestClient.cs index 221b573cb19d..b98e92a6b00e 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/DigitalTwinRestClient.cs @@ -56,8 +56,8 @@ internal HttpMessage CreateGetComponentsRequest(string digitalTwinId) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the list of interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The cancellation token to use. public async ValueTask> GetComponentsAsync(string digitalTwinId, CancellationToken cancellationToken = default) { @@ -89,8 +89,8 @@ public async ValueTask> GetComponentsAsync(strin } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the list of interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The cancellation token to use. public Response GetComponents(string digitalTwinId, CancellationToken cancellationToken = default) { @@ -145,10 +145,10 @@ internal HttpMessage CreateUpdateComponentRequest(string digitalTwinId, DigitalT return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. - /// Multiple interfaces desired properties to update. - /// The String to use. + /// Updates desired properties of multiple interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// The JSON representation of the update patch. + /// A string representing a weak ETag for digital twin, as per RFC7232. /// The cancellation token to use. public async ValueTask> UpdateComponentAsync(string digitalTwinId, DigitalTwinInterfacesPatch interfacesPatchInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -184,10 +184,10 @@ public async ValueTask> UpdateComponentAsync(str } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. - /// Multiple interfaces desired properties to update. - /// The String to use. + /// Updates desired properties of multiple interfaces. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// The JSON representation of the update patch. + /// A string representing a weak ETag for digital twin, as per RFC7232. /// The cancellation token to use. public Response UpdateComponent(string digitalTwinId, DigitalTwinInterfacesPatch interfacesPatchInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -239,8 +239,8 @@ internal HttpMessage CreateGetComponentRequest(string digitalTwinId, string inte return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the interface. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The interface name. /// The cancellation token to use. public async ValueTask> GetComponentAsync(string digitalTwinId, string interfaceName, CancellationToken cancellationToken = default) @@ -277,8 +277,8 @@ public async ValueTask> GetComponentAsync(string } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. + /// Get the interface. + /// The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional. /// The interface name. /// The cancellation token to use. public Response GetComponent(string digitalTwinId, string interfaceName, CancellationToken cancellationToken = default) @@ -333,7 +333,13 @@ internal HttpMessage CreateGetDigitalTwinModelRequest(string modelId, bool? expa return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// + /// Returns a DigitalTwin model definition for the given id. + /// + /// If "expand" is present in the query parameters and id is for a device capability model then it returns + /// + /// the capability metamodel with expanded interface definitions. + /// /// Model id Ex: <example>urn:contoso:TemperatureSensor:1</example>. /// /// Indicates whether to expand the device capability model's interface definitions inline or not. @@ -374,7 +380,13 @@ public async ValueTask For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// + /// Returns a DigitalTwin model definition for the given id. + /// + /// If "expand" is present in the query parameters and id is for a device capability model then it returns + /// + /// the capability metamodel with expanded interface definitions. + /// /// Model id Ex: <example>urn:contoso:TemperatureSensor:1</example>. /// /// Indicates whether to expand the device capability model's interface definitions inline or not. diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionClient.cs index c381f9b7b00e..190d68eecf3a 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionClient.cs @@ -32,7 +32,7 @@ internal FaultInjectionClient(ClientDiagnostics clientDiagnostics, HttpPipeline _pipeline = pipeline; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get FaultInjection entity. /// The cancellation token to use. public virtual async Task> GetAsync(CancellationToken cancellationToken = default) { @@ -49,7 +49,7 @@ public virtual async Task> GetAsync(Cancellat } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get FaultInjection entity. /// The cancellation token to use. public virtual Response Get(CancellationToken cancellationToken = default) { @@ -66,7 +66,7 @@ public virtual Response Get(CancellationToken cancella } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create or update FaultInjection entity. /// The FaultInjectionProperties to use. /// The cancellation token to use. public virtual async Task SetAsync(FaultInjectionProperties value, CancellationToken cancellationToken = default) @@ -84,7 +84,7 @@ public virtual async Task SetAsync(FaultInjectionProperties value, Can } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create or update FaultInjection entity. /// The FaultInjectionProperties to use. /// The cancellation token to use. public virtual Response Set(FaultInjectionProperties value, CancellationToken cancellationToken = default) diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionRestClient.cs index 1cb29e0a048a..55eb6b28dcb8 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/FaultInjectionRestClient.cs @@ -54,7 +54,7 @@ internal HttpMessage CreateGetRequest() return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get FaultInjection entity. /// The cancellation token to use. public async ValueTask> GetAsync(CancellationToken cancellationToken = default) { @@ -81,7 +81,7 @@ public async ValueTask> GetAsync(Cancellation } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get FaultInjection entity. /// The cancellation token to use. public Response Get(CancellationToken cancellationToken = default) { @@ -125,7 +125,7 @@ internal HttpMessage CreateSetRequest(FaultInjectionProperties value) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create or update FaultInjection entity. /// The FaultInjectionProperties to use. /// The cancellation token to use. public async ValueTask SetAsync(FaultInjectionProperties value, CancellationToken cancellationToken = default) @@ -146,7 +146,7 @@ public async ValueTask SetAsync(FaultInjectionProperties value, Cancel } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create or update FaultInjection entity. /// The FaultInjectionProperties to use. /// The cancellation token to use. public Response Set(FaultInjectionProperties value, CancellationToken cancellationToken = default) diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeClient.cs index 5b46adfa8172..93bb5365c980 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeClient.cs @@ -31,7 +31,7 @@ internal HttpRuntimeClient(ClientDiagnostics clientDiagnostics, HttpPipeline pip _pipeline = pipeline; } - /// This method is used to retrieve feedback of a cloud-to-device message See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// This method is used to retrieve feedback for cloud-to-device messages. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). /// The cancellation token to use. public virtual async Task ReceiveFeedbackNotificationAsync(CancellationToken cancellationToken = default) { @@ -48,7 +48,7 @@ public virtual async Task ReceiveFeedbackNotificationAsync(Cancellatio } } - /// This method is used to retrieve feedback of a cloud-to-device message See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// This method is used to retrieve feedback for cloud-to-device messages. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). /// The cancellation token to use. public virtual Response ReceiveFeedbackNotification(CancellationToken cancellationToken = default) { @@ -65,8 +65,8 @@ public virtual Response ReceiveFeedbackNotification(CancellationToken cancellati } } - /// This method completes a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when completing, a feedback message. A completed message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock token. + /// This method completes a cloud-to-device feedback message. A completed message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when completing a feedback message. /// The cancellation token to use. public virtual async Task CompleteFeedbackNotificationAsync(string lockToken, CancellationToken cancellationToken = default) { @@ -83,8 +83,8 @@ public virtual async Task CompleteFeedbackNotificationAsync(string loc } } - /// This method completes a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when completing, a feedback message. A completed message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock token. + /// This method completes a cloud-to-device feedback message. A completed message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when completing a feedback message. /// The cancellation token to use. public virtual Response CompleteFeedbackNotification(string lockToken, CancellationToken cancellationToken = default) { @@ -101,8 +101,8 @@ public virtual Response CompleteFeedbackNotification(string lockToken, Cancellat } } - /// This method abandons a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when abandoning, a feedback message. A abandoned message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock Token. + /// This method abandons a cloud-to-device feedback message. An abandoned message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when abandoning a feedback message. /// The cancellation token to use. public virtual async Task AbandonFeedbackNotificationAsync(string lockToken, CancellationToken cancellationToken = default) { @@ -119,8 +119,8 @@ public virtual async Task AbandonFeedbackNotificationAsync(string lock } } - /// This method abandons a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when abandoning, a feedback message. A abandoned message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock Token. + /// This method abandons a cloud-to-device feedback message. An abandoned message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when abandoning a feedback message. /// The cancellation token to use. public virtual Response AbandonFeedbackNotification(string lockToken, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeRestClient.cs index 09f2529f35f6..c89492cdf4a7 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/HttpRuntimeRestClient.cs @@ -52,7 +52,7 @@ internal HttpMessage CreateReceiveFeedbackNotificationRequest() return message; } - /// This method is used to retrieve feedback of a cloud-to-device message See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// This method is used to retrieve feedback for cloud-to-device messages. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). /// The cancellation token to use. public async ValueTask ReceiveFeedbackNotificationAsync(CancellationToken cancellationToken = default) { @@ -68,7 +68,7 @@ public async ValueTask ReceiveFeedbackNotificationAsync(CancellationTo } } - /// This method is used to retrieve feedback of a cloud-to-device message See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// This method is used to retrieve feedback for cloud-to-device messages. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). /// The cancellation token to use. public Response ReceiveFeedbackNotification(CancellationToken cancellationToken = default) { @@ -98,8 +98,8 @@ internal HttpMessage CreateCompleteFeedbackNotificationRequest(string lockToken) return message; } - /// This method completes a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when completing, a feedback message. A completed message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock token. + /// This method completes a cloud-to-device feedback message. A completed message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when completing a feedback message. /// The cancellation token to use. public async ValueTask CompleteFeedbackNotificationAsync(string lockToken, CancellationToken cancellationToken = default) { @@ -119,8 +119,8 @@ public async ValueTask CompleteFeedbackNotificationAsync(string lockTo } } - /// This method completes a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when completing, a feedback message. A completed message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock token. + /// This method completes a cloud-to-device feedback message. A completed message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when completing a feedback message. /// The cancellation token to use. public Response CompleteFeedbackNotification(string lockToken, CancellationToken cancellationToken = default) { @@ -155,8 +155,8 @@ internal HttpMessage CreateAbandonFeedbackNotificationRequest(string lockToken) return message; } - /// This method abandons a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when abandoning, a feedback message. A abandoned message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock Token. + /// This method abandons a cloud-to-device feedback message. An abandoned message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when abandoning a feedback message. /// The cancellation token to use. public async ValueTask AbandonFeedbackNotificationAsync(string lockToken, CancellationToken cancellationToken = default) { @@ -176,8 +176,8 @@ public async ValueTask AbandonFeedbackNotificationAsync(string lockTok } } - /// This method abandons a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when abandoning, a feedback message. A abandoned message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Lock Token. + /// This method abandons a cloud-to-device feedback message. An abandoned message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. + /// The lock token obtained when the C2D message was received, and provided to resolve race conditions when abandoning a feedback message. /// The cancellation token to use. public Response AbandonFeedbackNotification(string lockToken, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobClient.cs index b85007ca28e6..2d6152fb636c 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobClient.cs @@ -33,7 +33,7 @@ internal JobClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, s _pipeline = pipeline; } - /// Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create a new import or export job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// Specifies the job specification. /// The cancellation token to use. public virtual async Task> CreateImportExportJobAsync(JobProperties jobProperties, CancellationToken cancellationToken = default) @@ -51,7 +51,7 @@ public virtual async Task> CreateImportExportJobAsync(Jo } } - /// Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create a new import or export job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// Specifies the job specification. /// The cancellation token to use. public virtual Response CreateImportExportJob(JobProperties jobProperties, CancellationToken cancellationToken = default) @@ -69,7 +69,7 @@ public virtual Response CreateImportExportJob(JobProperties jobPr } } - /// Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the status of all import and export jobs in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// The cancellation token to use. public virtual async Task>> GetImportExportJobsAsync(CancellationToken cancellationToken = default) { @@ -86,7 +86,7 @@ public virtual async Task>> GetImportExpor } } - /// Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the status of all import and export jobs in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// The cancellation token to use. public virtual Response> GetImportExportJobs(CancellationToken cancellationToken = default) { @@ -103,8 +103,8 @@ public virtual Response> GetImportExportJobs(Cancel } } - /// Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Get the status of an import or export job in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. + /// The unique identifier of the job. /// The cancellation token to use. public virtual async Task> GetImportExportJobAsync(string id, CancellationToken cancellationToken = default) { @@ -121,8 +121,8 @@ public virtual async Task> GetImportExportJobAsync(strin } } - /// Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Get the status of an import or export job in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. + /// The unique identifier of the job. /// The cancellation token to use. public virtual Response GetImportExportJob(string id, CancellationToken cancellationToken = default) { @@ -139,8 +139,8 @@ public virtual Response GetImportExportJob(string id, Cancellatio } } - /// Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels an import or export job in IoT Hub. + /// The unique identifier of the job. /// The cancellation token to use. public virtual async Task> CancelImportExportJobAsync(string id, CancellationToken cancellationToken = default) { @@ -157,8 +157,8 @@ public virtual async Task> CancelImportExportJobAsync(string id } } - /// Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels an import or export job in IoT Hub. + /// The unique identifier of the job. /// The cancellation token to use. public virtual Response CancelImportExportJob(string id, CancellationToken cancellationToken = default) { @@ -175,8 +175,8 @@ public virtual Response CancelImportExportJob(string id, CancellationTok } } - /// Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Retrieves details of a scheduled job from IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public virtual async Task> GetJobAsync(string id, CancellationToken cancellationToken = default) { @@ -193,8 +193,8 @@ public virtual async Task> GetJobAsync(string id, Cancella } } - /// Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Retrieves details of a scheduled job from IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public virtual Response GetJob(string id, CancellationToken cancellationToken = default) { @@ -211,9 +211,9 @@ public virtual Response GetJob(string id, CancellationToken cancell } } - /// Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. - /// The JobRequest to use. + /// Creates a new job to schedule twin updates or direct methods on IoT Hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. + /// The job to be created. /// The cancellation token to use. public virtual async Task> CreateJobAsync(string id, JobRequest jobRequest, CancellationToken cancellationToken = default) { @@ -230,9 +230,9 @@ public virtual async Task> CreateJobAsync(string id, JobRe } } - /// Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. - /// The JobRequest to use. + /// Creates a new job to schedule twin updates or direct methods on IoT Hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. + /// The job to be created. /// The cancellation token to use. public virtual Response CreateJob(string id, JobRequest jobRequest, CancellationToken cancellationToken = default) { @@ -249,8 +249,8 @@ public virtual Response CreateJob(string id, JobRequest jobRequest, } } - /// Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels a scheduled job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public virtual async Task> CancelJobAsync(string id, CancellationToken cancellationToken = default) { @@ -267,8 +267,8 @@ public virtual async Task> CancelJobAsync(string id, Cance } } - /// Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels a scheduled job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public virtual Response CancelJob(string id, CancellationToken cancellationToken = default) { @@ -285,9 +285,9 @@ public virtual Response CancelJob(string id, CancellationToken canc } } - /// Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job Type. - /// Job Status. + /// Query IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The job type. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible job types. + /// The job status. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible statuses. /// The cancellation token to use. public virtual async Task> QueryJobsAsync(string jobType = null, string jobStatus = null, CancellationToken cancellationToken = default) { @@ -304,9 +304,9 @@ public virtual async Task> QueryJobsAsync(string jobType = } } - /// Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job Type. - /// Job Status. + /// Query IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The job type. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible job types. + /// The job status. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible statuses. /// The cancellation token to use. public virtual Response QueryJobs(string jobType = null, string jobStatus = null, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobRestClient.cs index ffe433881e21..fde0be1f0438 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/JobRestClient.cs @@ -59,7 +59,7 @@ internal HttpMessage CreateCreateImportExportJobRequest(JobProperties jobPropert return message; } - /// Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create a new import or export job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// Specifies the job specification. /// The cancellation token to use. public async ValueTask> CreateImportExportJobAsync(JobProperties jobProperties, CancellationToken cancellationToken = default) @@ -92,7 +92,7 @@ public async ValueTask> CreateImportExportJobAsync(JobPr } } - /// Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create a new import or export job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// Specifies the job specification. /// The cancellation token to use. public Response CreateImportExportJob(JobProperties jobProperties, CancellationToken cancellationToken = default) @@ -138,7 +138,7 @@ internal HttpMessage CreateGetImportExportJobsRequest() return message; } - /// Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the status of all import and export jobs in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// The cancellation token to use. public async ValueTask>> GetImportExportJobsAsync(CancellationToken cancellationToken = default) { @@ -177,7 +177,7 @@ public async ValueTask>> GetImportExportJo } } - /// Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the status of all import and export jobs in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. /// The cancellation token to use. public Response> GetImportExportJobs(CancellationToken cancellationToken = default) { @@ -230,8 +230,8 @@ internal HttpMessage CreateGetImportExportJobRequest(string id) return message; } - /// Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Get the status of an import or export job in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. + /// The unique identifier of the job. /// The cancellation token to use. public async ValueTask> GetImportExportJobAsync(string id, CancellationToken cancellationToken = default) { @@ -263,8 +263,8 @@ public async ValueTask> GetImportExportJobAsync(string i } } - /// Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Get the status of an import or export job in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. + /// The unique identifier of the job. /// The cancellation token to use. public Response GetImportExportJob(string id, CancellationToken cancellationToken = default) { @@ -310,8 +310,8 @@ internal HttpMessage CreateCancelImportExportJobRequest(string id) return message; } - /// Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels an import or export job in IoT Hub. + /// The unique identifier of the job. /// The cancellation token to use. public async ValueTask> CancelImportExportJobAsync(string id, CancellationToken cancellationToken = default) { @@ -345,8 +345,8 @@ public async ValueTask> CancelImportExportJobAsync(string id, C } } - /// Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels an import or export job in IoT Hub. + /// The unique identifier of the job. /// The cancellation token to use. public Response CancelImportExportJob(string id, CancellationToken cancellationToken = default) { @@ -394,8 +394,8 @@ internal HttpMessage CreateGetJobRequest(string id) return message; } - /// Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Retrieves details of a scheduled job from IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public async ValueTask> GetJobAsync(string id, CancellationToken cancellationToken = default) { @@ -427,8 +427,8 @@ public async ValueTask> GetJobAsync(string id, Cancellatio } } - /// Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Retrieves details of a scheduled job from IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public Response GetJob(string id, CancellationToken cancellationToken = default) { @@ -478,9 +478,9 @@ internal HttpMessage CreateCreateJobRequest(string id, JobRequest jobRequest) return message; } - /// Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. - /// The JobRequest to use. + /// Creates a new job to schedule twin updates or direct methods on IoT Hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. + /// The job to be created. /// The cancellation token to use. public async ValueTask> CreateJobAsync(string id, JobRequest jobRequest, CancellationToken cancellationToken = default) { @@ -516,9 +516,9 @@ public async ValueTask> CreateJobAsync(string id, JobReque } } - /// Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. - /// The JobRequest to use. + /// Creates a new job to schedule twin updates or direct methods on IoT Hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. + /// The job to be created. /// The cancellation token to use. public Response CreateJob(string id, JobRequest jobRequest, CancellationToken cancellationToken = default) { @@ -569,8 +569,8 @@ internal HttpMessage CreateCancelJobRequest(string id) return message; } - /// Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels a scheduled job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public async ValueTask> CancelJobAsync(string id, CancellationToken cancellationToken = default) { @@ -602,8 +602,8 @@ public async ValueTask> CancelJobAsync(string id, Cancella } } - /// Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job ID. + /// Cancels a scheduled job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. + /// The unique identifier of the job. /// The cancellation token to use. public Response CancelJob(string id, CancellationToken cancellationToken = default) { @@ -656,9 +656,9 @@ internal HttpMessage CreateQueryJobsRequest(string jobType, string jobStatus) return message; } - /// Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job Type. - /// Job Status. + /// Query IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The job type. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible job types. + /// The job status. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible statuses. /// The cancellation token to use. public async ValueTask> QueryJobsAsync(string jobType = null, string jobStatus = null, CancellationToken cancellationToken = default) { @@ -685,9 +685,9 @@ public async ValueTask> QueryJobsAsync(string jobType = nu } } - /// Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Job Type. - /// Job Status. + /// Query IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The job type. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible job types. + /// The job status. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible statuses. /// The cancellation token to use. public Response QueryJobs(string jobType = null, string jobStatus = null, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanism.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanism.cs index 39fa64318618..29560daef349 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanism.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanism.cs @@ -16,9 +16,9 @@ public AuthenticationMechanism() } /// Initializes a new instance of AuthenticationMechanism. - /// . - /// . - /// . + /// The primary and secondary keys used for SAS based authentication. + /// The primary and secondary x509 thumbprints used for x509 based authentication. + /// The type of authentication used when connecting to the service. internal AuthenticationMechanism(SymmetricKey symmetricKey, X509Thumbprint x509Thumbprint, AuthenticationMechanismType? type) { SymmetricKey = symmetricKey; @@ -26,8 +26,11 @@ internal AuthenticationMechanism(SymmetricKey symmetricKey, X509Thumbprint x509T Type = type; } + /// The primary and secondary keys used for SAS based authentication. public SymmetricKey SymmetricKey { get; set; } + /// The primary and secondary x509 thumbprints used for x509 based authentication. public X509Thumbprint X509Thumbprint { get; set; } + /// The type of authentication used when connecting to the service. public AuthenticationMechanismType? Type { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanismType.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanismType.cs index 3193fb4042fe..6cd25a18df97 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanismType.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/AuthenticationMechanismType.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// The AuthenticationMechanismType. + /// The type of authentication used when connecting to the service. public readonly partial struct AuthenticationMechanismType : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethod.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethod.cs index 9e8485d3584f..b37915cee4d4 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethod.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethod.cs @@ -16,10 +16,10 @@ public CloudToDeviceMethod() } /// Initializes a new instance of CloudToDeviceMethod. - /// Method to run. - /// Payload. - /// . - /// . + /// Name of the method to be executed. + /// The JSON-formatted direct method payload, up to 128kb in size. + /// Time (in seconds) that the service waits for the method invocation to return a response. It defaults to 30 seconds. Minimum allowed value is 5 seconds, maximum allowed value is 300 seconds. + /// Time (in seconds) that the service waits for the device to come online. It defaults to 0, meaning the device must already be online. Maximum allowed value is 300 seconds. internal CloudToDeviceMethod(string methodName, object payload, int? responseTimeoutInSeconds, int? connectTimeoutInSeconds) { MethodName = methodName; @@ -28,11 +28,13 @@ internal CloudToDeviceMethod(string methodName, object payload, int? responseTim ConnectTimeoutInSeconds = connectTimeoutInSeconds; } - /// Method to run. + /// Name of the method to be executed. public string MethodName { get; set; } - /// Payload. + /// The JSON-formatted direct method payload, up to 128kb in size. public object Payload { get; set; } + /// Time (in seconds) that the service waits for the method invocation to return a response. It defaults to 30 seconds. Minimum allowed value is 5 seconds, maximum allowed value is 300 seconds. public int? ResponseTimeoutInSeconds { get; set; } + /// Time (in seconds) that the service waits for the device to come online. It defaults to 0, meaning the device must already be online. Maximum allowed value is 300 seconds. public int? ConnectTimeoutInSeconds { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethodResult.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethodResult.cs index 7392fe972df6..692cc308f822 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethodResult.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/CloudToDeviceMethodResult.cs @@ -16,17 +16,17 @@ internal CloudToDeviceMethodResult() } /// Initializes a new instance of CloudToDeviceMethodResult. - /// Method invocation result status. - /// Method invocation result payload. + /// Method invocation result status, provided by the device. + /// The JSON-formatted direct method result payload, up to 128kb in size; provided by the device. internal CloudToDeviceMethodResult(int? status, object payload) { Status = status; Payload = payload; } - /// Method invocation result status. + /// Method invocation result status, provided by the device. public int? Status { get; } - /// Method invocation result payload. + /// The JSON-formatted direct method result payload, up to 128kb in size; provided by the device. public object Payload { get; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/Components17Cpi2FSchemasDigitaltwininterfacespatchPropertiesInterfacesAdditionalpropertiesPropertiesAdditionalproperties.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/Components17Cpi2FSchemasDigitaltwininterfacespatchPropertiesInterfacesAdditionalpropertiesPropertiesAdditionalproperties.cs index e04ca48d78f3..49398df0c495 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/Components17Cpi2FSchemasDigitaltwininterfacespatchPropertiesInterfacesAdditionalpropertiesPropertiesAdditionalproperties.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/Components17Cpi2FSchemasDigitaltwininterfacespatchPropertiesInterfacesAdditionalpropertiesPropertiesAdditionalproperties.cs @@ -16,12 +16,13 @@ public Components17Cpi2FSchemasDigitaltwininterfacespatchPropertiesInterfacesAdd } /// Initializes a new instance of Components17Cpi2FSchemasDigitaltwininterfacespatchPropertiesInterfacesAdditionalpropertiesPropertiesAdditionalproperties. - /// . + /// The desired property of the interface. internal Components17Cpi2FSchemasDigitaltwininterfacespatchPropertiesInterfacesAdditionalpropertiesPropertiesAdditionalproperties(DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired desired) { Desired = desired; } + /// The desired property of the interface. public DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired Desired { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationContent.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationContent.cs index 9076d94a6b87..00dc9c0fa7b2 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationContent.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationContent.cs @@ -18,9 +18,9 @@ public ConfigurationContent() } /// Initializes a new instance of ConfigurationContent. - /// Gets or sets device Configurations. - /// Gets or sets Modules Configurations. - /// Gets or sets Module Configurations. + /// Device Configurations. + /// Modules configuration content. + /// Module configuration content. internal ConfigurationContent(IDictionary deviceContent, IDictionary modulesContent, IDictionary moduleContent) { DeviceContent = deviceContent; @@ -28,11 +28,11 @@ internal ConfigurationContent(IDictionary deviceContent, IDictio ModuleContent = moduleContent; } - /// Gets or sets device Configurations. + /// Device Configurations. public IDictionary DeviceContent { get; set; } - /// Gets or sets Modules Configurations. + /// Modules configuration content. public IDictionary ModulesContent { get; set; } - /// Gets or sets Module Configurations. + /// Module configuration content. public IDictionary ModuleContent { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationMetrics.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationMetrics.cs index 1e01c5bc4cf5..f25dc8ec4881 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationMetrics.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationMetrics.cs @@ -9,7 +9,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// Configuration Metrics. + /// Configuration Metrics for IotHub devices and modules. public partial class ConfigurationMetrics { /// Initializes a new instance of ConfigurationMetrics. @@ -18,17 +18,17 @@ public ConfigurationMetrics() } /// Initializes a new instance of ConfigurationMetrics. - /// Dictionary of <integer>. - /// Dictionary of <string>. + /// TODO: Service to fill in. + /// TODO: Service to fill in. internal ConfigurationMetrics(IDictionary results, IDictionary queries) { Results = results; Queries = queries; } - /// Dictionary of <integer>. + /// TODO: Service to fill in. public IDictionary Results { get; set; } - /// Dictionary of <string>. + /// TODO: Service to fill in. public IDictionary Queries { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.Serialization.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.Serialization.cs index 1777f2482fae..18bb116dbe2b 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.Serialization.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.Serialization.cs @@ -23,13 +23,7 @@ void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) if (CustomMetricQueries != null) { writer.WritePropertyName("customMetricQueries"); - writer.WriteStartObject(); - foreach (var item in CustomMetricQueries) - { - writer.WritePropertyName(item.Key); - writer.WriteStringValue(item.Value); - } - writer.WriteEndObject(); + writer.WriteStringValue(CustomMetricQueries); } writer.WriteEndObject(); } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.cs index 1bcef201600b..853a7308b27e 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestInput.cs @@ -5,8 +5,6 @@ #nullable disable -using System.Collections.Generic; - namespace Azure.Iot.Hub.Service.Models { /// The ConfigurationQueriesTestInput. @@ -18,16 +16,17 @@ public ConfigurationQueriesTestInput() } /// Initializes a new instance of ConfigurationQueriesTestInput. - /// . - /// Dictionary of <string>. - internal ConfigurationQueriesTestInput(string targetCondition, IDictionary customMetricQueries) + /// The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties. + /// Queries on twin reported properties. + internal ConfigurationQueriesTestInput(string targetCondition, string customMetricQueries) { TargetCondition = targetCondition; CustomMetricQueries = customMetricQueries; } + /// The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties. public string TargetCondition { get; set; } - /// Dictionary of <string>. - public IDictionary CustomMetricQueries { get; set; } + /// Queries on twin reported properties. + public string CustomMetricQueries { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestResponse.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestResponse.cs index 0de5e371d600..6c5cbe8fe351 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestResponse.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ConfigurationQueriesTestResponse.cs @@ -18,7 +18,7 @@ internal ConfigurationQueriesTestResponse() } /// Initializes a new instance of ConfigurationQueriesTestResponse. - /// . + /// Errors running the target condition query. /// Dictionary of <string>. internal ConfigurationQueriesTestResponse(string targetConditionError, IReadOnlyDictionary customMetricQueryErrors) { @@ -26,6 +26,7 @@ internal ConfigurationQueriesTestResponse(string targetConditionError, IReadOnly CustomMetricQueryErrors = customMetricQueryErrors; } + /// Errors running the target condition query. public string TargetConditionError { get; } /// Dictionary of <string>. public IReadOnlyDictionary CustomMetricQueryErrors { get; } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceCapabilities.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceCapabilities.cs index 9139567dae8d..1416f42c9954 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceCapabilities.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceCapabilities.cs @@ -16,12 +16,13 @@ public DeviceCapabilities() } /// Initializes a new instance of DeviceCapabilities. - /// . + /// Whether or not this device is an edge device. internal DeviceCapabilities(bool? iotEdge) { IotEdge = iotEdge; } + /// Whether or not this device is an edge device. public bool? IotEdge { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceConnectionState.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceConnectionState.cs index bbfe874606d4..95630484724a 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceConnectionState.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceConnectionState.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// The DeviceConnectionState. + /// Tells whether the device is connected or not. public readonly partial struct DeviceConnectionState : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceIdentity.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceIdentity.cs index 68f179a39d15..eccfd53cbcf7 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceIdentity.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceIdentity.cs @@ -19,20 +19,20 @@ public DeviceIdentity() } /// Initializes a new instance of DeviceIdentity. - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// Status of Capabilities enabled on the device. - /// . - /// . + /// The unique identifier of this device. + /// An IoT hub-generated, case-sensitive string up to 128 characters long. This value is used to distinguish devices with the same deviceId, when they have been deleted and re-created. + /// A string representing a weak ETag for the device identity, as per RFC7232. + /// Tells whether the device is connected or not. + /// Flags whether a device is enabled or not. If disabled, a device cannot connect to the service. + /// A 128 character-long string that stores the reason for the device identity status. All UTF-8 characters are allowed. + /// A temporal indicator, showing the date and last time the connection state was updated. + /// The last timestamp of when the status field was updated. + /// A temporal indicator, showing the date and last time the device connected, received, or sent a message. + /// The number of cloud to device messages currently queued to be sent to the device. + /// The details on what authentication mechanisms are used by this device. + /// The set of capabilities that this device has. For example, if this device is an edge device or not. + /// The scope that this device belongs to. + /// TODO: service team needs to explain this. internal DeviceIdentity(string deviceId, string generationId, string etag, DeviceConnectionState? connectionState, DeviceStatus? status, string statusReason, DateTimeOffset? connectionStateUpdatedTime, DateTimeOffset? statusUpdatedTime, DateTimeOffset? lastActivityTime, int? cloudToDeviceMessageCount, AuthenticationMechanism authentication, DeviceCapabilities capabilities, string deviceScope, IList parentScopes) { DeviceId = deviceId; @@ -51,20 +51,33 @@ internal DeviceIdentity(string deviceId, string generationId, string etag, Devic ParentScopes = parentScopes; } + /// The unique identifier of this device. public string DeviceId { get; set; } + /// An IoT hub-generated, case-sensitive string up to 128 characters long. This value is used to distinguish devices with the same deviceId, when they have been deleted and re-created. public string GenerationId { get; set; } + /// A string representing a weak ETag for the device identity, as per RFC7232. public string Etag { get; set; } + /// Tells whether the device is connected or not. public DeviceConnectionState? ConnectionState { get; set; } + /// Flags whether a device is enabled or not. If disabled, a device cannot connect to the service. public DeviceStatus? Status { get; set; } + /// A 128 character-long string that stores the reason for the device identity status. All UTF-8 characters are allowed. public string StatusReason { get; set; } + /// A temporal indicator, showing the date and last time the connection state was updated. public DateTimeOffset? ConnectionStateUpdatedTime { get; set; } + /// The last timestamp of when the status field was updated. public DateTimeOffset? StatusUpdatedTime { get; set; } + /// A temporal indicator, showing the date and last time the device connected, received, or sent a message. public DateTimeOffset? LastActivityTime { get; set; } + /// The number of cloud to device messages currently queued to be sent to the device. public int? CloudToDeviceMessageCount { get; set; } + /// The details on what authentication mechanisms are used by this device. public AuthenticationMechanism Authentication { get; set; } - /// Status of Capabilities enabled on the device. + /// The set of capabilities that this device has. For example, if this device is an edge device or not. public DeviceCapabilities Capabilities { get; set; } + /// The scope that this device belongs to. public string DeviceScope { get; set; } + /// TODO: service team needs to explain this. public IList ParentScopes { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationError.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationError.cs index cbf26ff82cec..4a02df06ed00 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationError.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationError.cs @@ -16,11 +16,11 @@ internal DeviceRegistryOperationError() } /// Initializes a new instance of DeviceRegistryOperationError. - /// The ID of the device that indicated the error. + /// Identifier of the device that indicated the error. /// ErrorCode associated with the error. /// Additional details associated with the error. - /// . - /// . + /// Identifier of the module associated with the error, if applicable. + /// The type of the operation that failed. internal DeviceRegistryOperationError(string deviceId, DeviceRegistryOperationErrorCode? errorCode, string errorStatus, string moduleId, string operation) { DeviceId = deviceId; @@ -30,13 +30,15 @@ internal DeviceRegistryOperationError(string deviceId, DeviceRegistryOperationEr Operation = operation; } - /// The ID of the device that indicated the error. + /// Identifier of the device that indicated the error. public string DeviceId { get; } /// ErrorCode associated with the error. public DeviceRegistryOperationErrorCode? ErrorCode { get; } /// Additional details associated with the error. public string ErrorStatus { get; } + /// Identifier of the module associated with the error, if applicable. public string ModuleId { get; } + /// The type of the operation that failed. public string Operation { get; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationWarning.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationWarning.cs index e9f354eed096..943c061de489 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationWarning.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceRegistryOperationWarning.cs @@ -17,8 +17,8 @@ internal DeviceRegistryOperationWarning() } /// Initializes a new instance of DeviceRegistryOperationWarning. - /// The ID of the device that indicated the warning. - /// . + /// Identifier of the device that indicated the warning. + /// The code associated with the warning. /// Additional details associated with the warning. internal DeviceRegistryOperationWarning(string deviceId, string warningCode, string warningStatus) { @@ -27,8 +27,9 @@ internal DeviceRegistryOperationWarning(string deviceId, string warningCode, str WarningStatus = warningStatus; } - /// The ID of the device that indicated the warning. + /// Identifier of the device that indicated the warning. public string DeviceId { get; } + /// The code associated with the warning. public string WarningCode { get; } /// Additional details associated with the warning. public string WarningStatus { get; } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceStatus.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceStatus.cs index 7833cc895cd2..f06915a0fb9f 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceStatus.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DeviceStatus.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// The DeviceStatus. + /// Flags whether a device is enabled or not. If disabled, a device cannot connect to the service. public readonly partial struct DeviceStatus : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired.cs index 8090b508a848..a8cad41d7326 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired.cs @@ -7,7 +7,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// The DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired. + /// The desired property of the interface. public partial class DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired { /// Initializes a new instance of DigitalTwinInterfacesPatchInterfacesPropertiesAdditionalPropertiesDesired. diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDevice.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDevice.cs index 2c68c3e98fa5..e0421bc11807 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDevice.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDevice.cs @@ -18,19 +18,19 @@ public ExportImportDevice() } /// Initializes a new instance of ExportImportDevice. - /// Device Id is always required. - /// ModuleId is applicable to modules only. + /// Identifier of the device to perform this operation on. + /// Identifier of the module to perform this operation on, if applicable. /// ETag parameter is only used for pre-conditioning the update when importMode is updateIfMatchETag. - /// . - /// Status is optional and defaults to enabled. - /// . + /// The type of registry operation and if ETag should be ignored or not. + /// Flags whether a module is enabled or not. If disabled, a module cannot connect to the service. + /// A 128 character-long string that stores the reason for the device identity status. All UTF-8 characters are allowed. /// Authentication parameter is optional and defaults to SAS if not provided. In that case, we auto-generate primary/secondary access keys. /// twinETag parameter is only used for pre-conditioning the update when importMode is updateTwinIfMatchETag. /// Dictionary of <any>. - /// Properties are optional and defaults to empty object. - /// Capabilities param is optional and defaults to no capability. - /// . - /// . + /// TODO need service folks to explain this. + /// Status of capabilities enabled on the device. + /// The scope that this identity belongs to. + /// TODO: service team needs to explain this. internal ExportImportDevice(string id, string moduleId, string eTag, ExportImportDeviceImportMode? importMode, ExportImportDeviceStatus? status, string statusReason, AuthenticationMechanism authentication, string twinETag, IDictionary tags, PropertyContainer properties, DeviceCapabilities capabilities, string deviceScope, IList parentScopes) { Id = id; @@ -48,15 +48,17 @@ internal ExportImportDevice(string id, string moduleId, string eTag, ExportImpor ParentScopes = parentScopes; } - /// Device Id is always required. + /// Identifier of the device to perform this operation on. public string Id { get; set; } - /// ModuleId is applicable to modules only. + /// Identifier of the module to perform this operation on, if applicable. public string ModuleId { get; set; } /// ETag parameter is only used for pre-conditioning the update when importMode is updateIfMatchETag. public string ETag { get; set; } + /// The type of registry operation and if ETag should be ignored or not. public ExportImportDeviceImportMode? ImportMode { get; set; } - /// Status is optional and defaults to enabled. + /// Flags whether a module is enabled or not. If disabled, a module cannot connect to the service. public ExportImportDeviceStatus? Status { get; set; } + /// A 128 character-long string that stores the reason for the device identity status. All UTF-8 characters are allowed. public string StatusReason { get; set; } /// Authentication parameter is optional and defaults to SAS if not provided. In that case, we auto-generate primary/secondary access keys. public AuthenticationMechanism Authentication { get; set; } @@ -64,11 +66,13 @@ internal ExportImportDevice(string id, string moduleId, string eTag, ExportImpor public string TwinETag { get; set; } /// Dictionary of <any>. public IDictionary Tags { get; set; } - /// Properties are optional and defaults to empty object. + /// TODO need service folks to explain this. public PropertyContainer Properties { get; set; } - /// Capabilities param is optional and defaults to no capability. + /// Status of capabilities enabled on the device. public DeviceCapabilities Capabilities { get; set; } + /// The scope that this identity belongs to. public string DeviceScope { get; set; } + /// TODO: service team needs to explain this. public IList ParentScopes { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceImportMode.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceImportMode.cs index 034ef0959434..c706aa34419a 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceImportMode.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceImportMode.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// The ExportImportDeviceImportMode. + /// The type of registry operation and if ETag should be ignored or not. public readonly partial struct ExportImportDeviceImportMode : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceStatus.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceStatus.cs index 4bee335d162b..b2bfdb350ee2 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceStatus.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ExportImportDeviceStatus.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// Status is optional and defaults to enabled. + /// Flags whether a module is enabled or not. If disabled, a module cannot connect to the service. public readonly partial struct ExportImportDeviceStatus : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionProperties.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionProperties.cs index 580c68f83739..aa666c811095 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionProperties.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionProperties.cs @@ -16,15 +16,17 @@ public FaultInjectionConnectionProperties() } /// Initializes a new instance of FaultInjectionConnectionProperties. - /// . - /// . + /// Action to perform. + /// TODO: to be filled by the service team. internal FaultInjectionConnectionProperties(FaultInjectionConnectionPropertiesAction? action, int? blockDurationInMinutes) { Action = action; BlockDurationInMinutes = blockDurationInMinutes; } + /// Action to perform. public FaultInjectionConnectionPropertiesAction? Action { get; set; } + /// TODO: to be filled by the service team. public int? BlockDurationInMinutes { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionPropertiesAction.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionPropertiesAction.cs index e5500557c419..f614c93996da 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionPropertiesAction.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionConnectionPropertiesAction.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// The FaultInjectionConnectionPropertiesAction. + /// Action to perform. public readonly partial struct FaultInjectionConnectionPropertiesAction : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionProperties.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionProperties.cs index 70659baf8633..74933440191e 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionProperties.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/FaultInjectionProperties.cs @@ -18,8 +18,8 @@ public FaultInjectionProperties() } /// Initializes a new instance of FaultInjectionProperties. - /// . - /// . + /// Name of the IotHub. + /// TODO: to be filled by the service team. /// Service generated. internal FaultInjectionProperties(string iotHubName, FaultInjectionConnectionProperties connection, DateTimeOffset? lastUpdatedTimeUtc) { @@ -28,7 +28,9 @@ internal FaultInjectionProperties(string iotHubName, FaultInjectionConnectionPro LastUpdatedTimeUtc = lastUpdatedTimeUtc; } + /// Name of the IotHub. public string IotHubName { get; set; } + /// TODO: to be filled by the service team. public FaultInjectionConnectionProperties Connection { get; set; } /// Service generated. public DateTimeOffset? LastUpdatedTimeUtc { get; set; } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobProperties.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobProperties.cs index e08c1f5d8cf2..04cfb650a80e 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobProperties.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobProperties.cs @@ -18,43 +18,19 @@ public JobProperties() } /// Initializes a new instance of JobProperties. - /// System generated. Ignored at creation. - /// System generated. Ignored at creation. - /// - /// System generated. Ignored at creation. - /// - /// Represents the time the job stopped processing. - /// - /// - /// Required. - /// - /// The type of job to execute. - /// - /// System generated. Ignored at creation. - /// - /// System generated. Ignored at creation. - /// - /// Represents the percentage of completion. - /// + /// The unique identifier of the job. + /// The start time of the job in UTC. + /// The time the job stopped. + /// The type of job to execute. + /// The status of the job. + /// Represents the percentage of completion. /// URI containing SAS token to a blob container that contains registry data to sync. /// The blob name to be used when importing from the provided input blob container. - /// URI containing SAS token to a blob container. This is used to output the status of the job and the results. - /// - /// The name of the blob that will be created in the provided output blob container. This blob will contain - /// - /// the exported device registry information for the IoT Hub. - /// - /// - /// Optional for export jobs; ignored for other jobs. Default: false. If false, authorization keys are included - /// - /// in export output. Keys are exported as null otherwise. - /// + /// SAS token to access a blob container. This is used to output the status of the job and the results. + /// The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub. + /// Optional for export jobs; ignored for other jobs. If not specified, the service defaults to false. If false, authorization keys are included in export output. Keys are exported as null otherwise. /// Specifies authentication type being used for connecting to storage account. - /// - /// System genereated. Ignored at creation. - /// - /// If status == failure, this represents a string containing the reason. - /// + /// Contains the reason for the failure, if a failure occurred. internal JobProperties(string jobId, DateTimeOffset? startTimeUtc, DateTimeOffset? endTimeUtc, JobPropertiesType? type, JobPropertiesStatus? status, int? progress, string inputBlobContainerUri, string inputBlobName, string outputBlobContainerUri, string outputBlobName, bool? excludeKeysInExport, JobPropertiesStorageAuthenticationType? storageAuthenticationType, string failureReason) { JobId = jobId; @@ -72,55 +48,31 @@ internal JobProperties(string jobId, DateTimeOffset? startTimeUtc, DateTimeOffse FailureReason = failureReason; } - /// System generated. Ignored at creation. + /// The unique identifier of the job. public string JobId { get; set; } - /// System generated. Ignored at creation. + /// The start time of the job in UTC. public DateTimeOffset? StartTimeUtc { get; set; } - /// - /// System generated. Ignored at creation. - /// - /// Represents the time the job stopped processing. - /// + /// The time the job stopped. public DateTimeOffset? EndTimeUtc { get; set; } - /// - /// Required. - /// - /// The type of job to execute. - /// + /// The type of job to execute. public JobPropertiesType? Type { get; set; } - /// System generated. Ignored at creation. + /// The status of the job. public JobPropertiesStatus? Status { get; set; } - /// - /// System generated. Ignored at creation. - /// - /// Represents the percentage of completion. - /// + /// Represents the percentage of completion. public int? Progress { get; set; } /// URI containing SAS token to a blob container that contains registry data to sync. public string InputBlobContainerUri { get; set; } /// The blob name to be used when importing from the provided input blob container. public string InputBlobName { get; set; } - /// URI containing SAS token to a blob container. This is used to output the status of the job and the results. + /// SAS token to access a blob container. This is used to output the status of the job and the results. public string OutputBlobContainerUri { get; set; } - /// - /// The name of the blob that will be created in the provided output blob container. This blob will contain - /// - /// the exported device registry information for the IoT Hub. - /// + /// The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub. public string OutputBlobName { get; set; } - /// - /// Optional for export jobs; ignored for other jobs. Default: false. If false, authorization keys are included - /// - /// in export output. Keys are exported as null otherwise. - /// + /// Optional for export jobs; ignored for other jobs. If not specified, the service defaults to false. If false, authorization keys are included in export output. Keys are exported as null otherwise. public bool? ExcludeKeysInExport { get; set; } /// Specifies authentication type being used for connecting to storage account. public JobPropertiesStorageAuthenticationType? StorageAuthenticationType { get; set; } - /// - /// System genereated. Ignored at creation. - /// - /// If status == failure, this represents a string containing the reason. - /// + /// Contains the reason for the failure, if a failure occurred. public string FailureReason { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesStatus.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesStatus.cs index b6f91a5bba1f..827e1a7bae95 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesStatus.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesStatus.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// System generated. Ignored at creation. + /// The status of the job. public readonly partial struct JobPropertiesStatus : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesType.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesType.cs index a3fb4452be8d..0db5f2fa426a 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesType.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobPropertiesType.cs @@ -10,11 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// - /// Required. - /// - /// The type of job to execute. - /// + /// The type of job to execute. public readonly partial struct JobPropertiesType : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequest.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequest.cs index 03918194d7b0..2b665d813b07 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequest.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequest.cs @@ -19,22 +19,10 @@ public JobRequest() /// Initializes a new instance of JobRequest. /// Job identifier. - /// - /// Required. - /// - /// The type of job to execute. - /// - /// - /// Required if jobType is cloudToDeviceMethod. - /// - /// The method type and parameters. - /// - /// Twin Representation. - /// - /// Required if jobType is updateTwin or cloudToDeviceMethod. - /// - /// Condition for device query to get devices to execute the job on. - /// + /// The type of job to execute. + /// Required if jobType is cloudToDeviceMethod. The method type and parameters. + /// The state information for a device or module. Implicitly created and deleted when the corresponding device/ module identity is created or deleted in IoT Hub. + /// Required if jobType is updateTwin or cloudToDeviceMethod. Condition for device query to get devices to execute the job on. /// ISO 8601 date time to start the job. /// Max execution time in secounds (ttl duration). internal JobRequest(string jobId, JobRequestType? type, CloudToDeviceMethod cloudToDeviceMethod, TwinData updateTwin, string queryCondition, DateTimeOffset? startTime, long? maxExecutionTimeInSeconds) @@ -50,25 +38,13 @@ internal JobRequest(string jobId, JobRequestType? type, CloudToDeviceMethod clou /// Job identifier. public string JobId { get; set; } - /// - /// Required. - /// - /// The type of job to execute. - /// + /// The type of job to execute. public JobRequestType? Type { get; set; } - /// - /// Required if jobType is cloudToDeviceMethod. - /// - /// The method type and parameters. - /// + /// Required if jobType is cloudToDeviceMethod. The method type and parameters. public CloudToDeviceMethod CloudToDeviceMethod { get; set; } - /// Twin Representation. + /// The state information for a device or module. Implicitly created and deleted when the corresponding device/ module identity is created or deleted in IoT Hub. public TwinData UpdateTwin { get; set; } - /// - /// Required if jobType is updateTwin or cloudToDeviceMethod. - /// - /// Condition for device query to get devices to execute the job on. - /// + /// Required if jobType is updateTwin or cloudToDeviceMethod. Condition for device query to get devices to execute the job on. public string QueryCondition { get; set; } /// ISO 8601 date time to start the job. public DateTimeOffset? StartTime { get; set; } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequestType.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequestType.cs index 2f253f3d8749..ac8334afba3c 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequestType.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobRequestType.cs @@ -10,11 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// - /// Required. - /// - /// The type of job to execute. - /// + /// The type of job to execute. public readonly partial struct JobRequestType : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponse.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponse.cs index 8413ccfe5f13..579ed43ef3e0 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponse.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponse.cs @@ -18,33 +18,17 @@ internal JobResponse() } /// Initializes a new instance of JobResponse. - /// System generated. Ignored at creation. + /// The unique identifier of the job. /// Device query condition. - /// System generated. Ignored at creation. + /// The creation time of the job. /// Scheduled job start time in UTC. - /// - /// System generated. Ignored at creation. - /// - /// Represents the time the job stopped processing. - /// + /// The time the job stopped. /// Max execution time in secounds (ttl duration). - /// - /// Required. - /// - /// The type of job to execute. - /// - /// - /// Required if jobType is cloudToDeviceMethod. - /// - /// The method type and parameters. - /// - /// Twin Representation. - /// System generated. Ignored at creation. - /// - /// System generated. Ignored at creation. - /// - /// If status == failure, this represents a string containing the reason. - /// + /// The type of job to execute. + /// Required if jobType is cloudToDeviceMethod. The method type and parameters. + /// The state information for a device or module. Implicitly created and deleted when the corresponding device/ module identity is created or deleted in IoT Hub. + /// The status of the job. + /// Contains the reason for the failure, if a failure occurred. /// Status message for the job. /// Job details. internal JobResponse(string jobId, string queryCondition, DateTimeOffset? createdTime, DateTimeOffset? startTime, DateTimeOffset? endTime, long? maxExecutionTimeInSeconds, JobResponseType? type, CloudToDeviceMethod cloudToDeviceMethod, TwinData updateTwin, JobResponseStatus? status, string failureReason, string statusMessage, DeviceJobStatistics deviceJobStatistics) @@ -64,43 +48,27 @@ internal JobResponse(string jobId, string queryCondition, DateTimeOffset? create DeviceJobStatistics = deviceJobStatistics; } - /// System generated. Ignored at creation. + /// The unique identifier of the job. public string JobId { get; } /// Device query condition. public string QueryCondition { get; } - /// System generated. Ignored at creation. + /// The creation time of the job. public DateTimeOffset? CreatedTime { get; } /// Scheduled job start time in UTC. public DateTimeOffset? StartTime { get; } - /// - /// System generated. Ignored at creation. - /// - /// Represents the time the job stopped processing. - /// + /// The time the job stopped. public DateTimeOffset? EndTime { get; } /// Max execution time in secounds (ttl duration). public long? MaxExecutionTimeInSeconds { get; } - /// - /// Required. - /// - /// The type of job to execute. - /// + /// The type of job to execute. public JobResponseType? Type { get; } - /// - /// Required if jobType is cloudToDeviceMethod. - /// - /// The method type and parameters. - /// + /// Required if jobType is cloudToDeviceMethod. The method type and parameters. public CloudToDeviceMethod CloudToDeviceMethod { get; } - /// Twin Representation. + /// The state information for a device or module. Implicitly created and deleted when the corresponding device/ module identity is created or deleted in IoT Hub. public TwinData UpdateTwin { get; } - /// System generated. Ignored at creation. + /// The status of the job. public JobResponseStatus? Status { get; } - /// - /// System generated. Ignored at creation. - /// - /// If status == failure, this represents a string containing the reason. - /// + /// Contains the reason for the failure, if a failure occurred. public string FailureReason { get; } /// Status message for the job. public string StatusMessage { get; } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseStatus.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseStatus.cs index 8d661c8da26b..9823d561327a 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseStatus.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseStatus.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// System generated. Ignored at creation. + /// The status of the job. public readonly partial struct JobResponseStatus : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseType.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseType.cs index b4a9d24c8ee5..93bd7126a6b1 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseType.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/JobResponseType.cs @@ -10,11 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// - /// Required. - /// - /// The type of job to execute. - /// + /// The type of job to execute. public readonly partial struct JobResponseType : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleConnectionState.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleConnectionState.cs index 67b61a6f61c4..3b6b062385f8 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleConnectionState.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleConnectionState.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// The ModuleConnectionState. + /// Tells whether the module is connected or not. public readonly partial struct ModuleConnectionState : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleIdentity.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleIdentity.cs index f59c8a4656e6..5f668c4dc5b1 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleIdentity.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ModuleIdentity.cs @@ -18,16 +18,16 @@ public ModuleIdentity() } /// Initializes a new instance of ModuleIdentity. - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// . - /// . + /// The unique identifier of this module. + /// Identifies who manages this module. For instance, this value is "IotEdge" if the edge runtime owns this module. + /// The unique identifier of the device that has this module. + /// An IoT hub-generated, case-sensitive string up to 128 characters long. This value is used to distinguish modules with the same moduleId, when they have been deleted and re-created. + /// A string representing a weak ETag for the module identity, as per RFC7232. + /// Tells whether the module is connected or not. + /// A temporal indicator, showing the date and last time the connection state was updated. + /// A temporal indicator, showing the date and last time the device connected, received, or sent a message. + /// The number of cloud to module messages currently queued to be sent to the module. + /// The details on what authentication mechanisms are used by this module when connecting to the service and edgehub. internal ModuleIdentity(string moduleId, string managedBy, string deviceId, string generationId, string etag, ModuleConnectionState? connectionState, DateTimeOffset? connectionStateUpdatedTime, DateTimeOffset? lastActivityTime, int? cloudToDeviceMessageCount, AuthenticationMechanism authentication) { ModuleId = moduleId; @@ -42,15 +42,25 @@ internal ModuleIdentity(string moduleId, string managedBy, string deviceId, stri Authentication = authentication; } + /// The unique identifier of this module. public string ModuleId { get; set; } + /// Identifies who manages this module. For instance, this value is "IotEdge" if the edge runtime owns this module. public string ManagedBy { get; set; } + /// The unique identifier of the device that has this module. public string DeviceId { get; set; } + /// An IoT hub-generated, case-sensitive string up to 128 characters long. This value is used to distinguish modules with the same moduleId, when they have been deleted and re-created. public string GenerationId { get; set; } + /// A string representing a weak ETag for the module identity, as per RFC7232. public string Etag { get; set; } + /// Tells whether the module is connected or not. public ModuleConnectionState? ConnectionState { get; set; } + /// A temporal indicator, showing the date and last time the connection state was updated. public DateTimeOffset? ConnectionStateUpdatedTime { get; set; } + /// A temporal indicator, showing the date and last time the device connected, received, or sent a message. public DateTimeOffset? LastActivityTime { get; set; } + /// The number of cloud to module messages currently queued to be sent to the module. public int? CloudToDeviceMessageCount { get; set; } + /// The details on what authentication mechanisms are used by this module when connecting to the service and edgehub. public AuthenticationMechanism Authentication { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/PurgeMessageQueueResult.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/PurgeMessageQueueResult.cs index e8807a2b23d7..26e114aee9c3 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/PurgeMessageQueueResult.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/PurgeMessageQueueResult.cs @@ -16,7 +16,7 @@ internal PurgeMessageQueueResult() } /// Initializes a new instance of PurgeMessageQueueResult. - /// . + /// The total number of messages purged. /// The ID of the device whose messages are being purged. /// The ID of the device whose messages are being purged. internal PurgeMessageQueueResult(int? totalMessagesPurged, string deviceId, string moduleId) @@ -26,6 +26,7 @@ internal PurgeMessageQueueResult(int? totalMessagesPurged, string deviceId, stri ModuleId = moduleId; } + /// The total number of messages purged. public int? TotalMessagesPurged { get; } /// The ID of the device whose messages are being purged. public string DeviceId { get; } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/RegistryStatistics.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/RegistryStatistics.cs index 53588ba9f6c9..54b02427eb72 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/RegistryStatistics.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/RegistryStatistics.cs @@ -16,9 +16,9 @@ internal RegistryStatistics() } /// Initializes a new instance of RegistryStatistics. - /// . - /// . - /// . + /// The total number of devices registered for this hub. + /// The number of currently enabled devices. + /// The number of currently disabled devices. internal RegistryStatistics(long? totalDeviceCount, long? enabledDeviceCount, long? disabledDeviceCount) { TotalDeviceCount = totalDeviceCount; @@ -26,8 +26,11 @@ internal RegistryStatistics(long? totalDeviceCount, long? enabledDeviceCount, lo DisabledDeviceCount = disabledDeviceCount; } + /// The total number of devices registered for this hub. public long? TotalDeviceCount { get; } + /// The number of currently enabled devices. public long? EnabledDeviceCount { get; } + /// The number of currently disabled devices. public long? DisabledDeviceCount { get; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ServiceStatistics.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ServiceStatistics.cs index 718fe07afa2e..00f2ecfb9a0c 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ServiceStatistics.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/ServiceStatistics.cs @@ -16,12 +16,13 @@ internal ServiceStatistics() } /// Initializes a new instance of ServiceStatistics. - /// . + /// The number of currently connected devices. internal ServiceStatistics(long? connectedDeviceCount) { ConnectedDeviceCount = connectedDeviceCount; } + /// The number of currently connected devices. public long? ConnectedDeviceCount { get; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/SymmetricKey.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/SymmetricKey.cs index ba3b497b7f6c..693e594860e1 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/SymmetricKey.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/SymmetricKey.cs @@ -16,15 +16,17 @@ public SymmetricKey() } /// Initializes a new instance of SymmetricKey. - /// . - /// . + /// The base 64 encoded primary key of your device. + /// The base 64 encoded secondary key of your device. internal SymmetricKey(string primaryKey, string secondaryKey) { PrimaryKey = primaryKey; SecondaryKey = secondaryKey; } + /// The base 64 encoded primary key of your device. public string PrimaryKey { get; set; } + /// The base 64 encoded secondary key of your device. public string SecondaryKey { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConfiguration.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConfiguration.cs index 1b1c42ad873c..7424215fc5b8 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConfiguration.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConfiguration.cs @@ -19,17 +19,17 @@ public TwinConfiguration() } /// Initializes a new instance of TwinConfiguration. - /// Gets Identifier for the configuration. - /// Gets Schema version for the configuration. - /// Gets or sets labels for the configuration. - /// Gets or sets Content for the configuration. - /// Gets or sets Target Condition for the configuration. - /// Gets creation time for the configuration. - /// Gets last update time for the configuration. - /// Gets or sets Priority for the configuration. - /// System Configuration Metrics. - /// Custom Configuration Metrics. - /// Gets or sets configuration's ETag. + /// The unique identifier of the configuration. + /// Schema version of the configuration. + /// Key-value pairs used to describe a configuration. + /// Content of the configuration. + /// The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties. + /// Creation time of the configuration. + /// Update time of the configuration. + /// The priority number assigned to the configuration. + /// Metrics calculated by IoT Hub that cannot be customized. + /// Custom metrics specified by developer as queries against twin reported properties. + /// ETag of the configuration. internal TwinConfiguration(string id, string schemaVersion, IDictionary labels, ConfigurationContent content, string targetCondition, DateTimeOffset? createdTimeUtc, DateTimeOffset? lastUpdatedTimeUtc, int? priority, ConfigurationMetrics systemMetrics, ConfigurationMetrics metrics, string etag) { Id = id; @@ -45,27 +45,27 @@ internal TwinConfiguration(string id, string schemaVersion, IDictionary Gets Identifier for the configuration. + /// The unique identifier of the configuration. public string Id { get; set; } - /// Gets Schema version for the configuration. + /// Schema version of the configuration. public string SchemaVersion { get; set; } - /// Gets or sets labels for the configuration. + /// Key-value pairs used to describe a configuration. public IDictionary Labels { get; set; } - /// Gets or sets Content for the configuration. + /// Content of the configuration. public ConfigurationContent Content { get; set; } - /// Gets or sets Target Condition for the configuration. + /// The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties. public string TargetCondition { get; set; } - /// Gets creation time for the configuration. + /// Creation time of the configuration. public DateTimeOffset? CreatedTimeUtc { get; set; } - /// Gets last update time for the configuration. + /// Update time of the configuration. public DateTimeOffset? LastUpdatedTimeUtc { get; set; } - /// Gets or sets Priority for the configuration. + /// The priority number assigned to the configuration. public int? Priority { get; set; } - /// System Configuration Metrics. + /// Metrics calculated by IoT Hub that cannot be customized. public ConfigurationMetrics SystemMetrics { get; set; } - /// Custom Configuration Metrics. + /// Custom metrics specified by developer as queries against twin reported properties. public ConfigurationMetrics Metrics { get; set; } - /// Gets or sets configuration's ETag. + /// ETag of the configuration. public string Etag { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConnectionState.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConnectionState.cs index d1e05e0a68c6..b06e2ec509a9 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConnectionState.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinConnectionState.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// Corresponding Device's ConnectionState. + /// The device's connection state. public readonly partial struct TwinConnectionState : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinData.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinData.cs index 8fb846997704..b1d69e2216f0 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinData.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinData.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// Twin Representation. + /// The state information for a device or module. Implicitly created and deleted when the corresponding device/ module identity is created or deleted in IoT Hub. public partial class TwinData { /// Initializes a new instance of TwinData. @@ -19,24 +19,24 @@ public TwinData() } /// Initializes a new instance of TwinData. - /// The deviceId uniquely identifies the device in the IoT hub's identity registry. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. - /// Gets and sets the Module Id. - /// A JSON document read and written by the solution back end. Tags are not visible to device apps. - /// Gets and sets the Twin properties. - /// Twin's ETag. + /// The unique identifier of the device in the IoT hub's identity registry. It is a case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars, and the following special characters {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. + /// The unique identifier of the module in the IoT hub's identity registry. It is a case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars, and the following special characters {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. + /// A collection of key-value pairs read and written by the solution back end. They are not visible to device apps. + /// The twin's desired and reported properties. + /// TODO - which operation does this affect - update tags/ properties etc?. /// Version for device twin, including tags and desired properties. - /// Device's ETag. - /// Gets the corresponding Device's Status. - /// Reason, if any, for the corresponding Device to be in specified Status. - /// Time when the corresponding Device's Status was last updated. - /// Corresponding Device's ConnectionState. + /// TODO - which operation does this affect?. + /// Flags whether a device is enabled or not. If disabled, a device cannot connect to the service. + /// Reason, if any, for the device's current status. + /// Time when the corresponding device's status was last updated. + /// The device's connection state. /// The last time the device connected, received or sent a message. In ISO8601 datetime format in UTC, for example, 2015-01-28T16:24:48.789Z. This does not update if the device uses the HTTP/1 protocol to perform messaging operations. /// Number of messages sent to the corresponding Device from the Cloud. /// Corresponding Device's authentication type. /// Corresponding Device's X509 thumbprint. /// Status of Capabilities enabled on the device. - /// . - /// . + /// Scope to which this device instance belongs to. + /// TODO: new property added - need explanation. internal TwinData(string deviceId, string moduleId, IDictionary tags, TwinProperties properties, string etag, long? version, string deviceEtag, TwinStatus? status, string statusReason, DateTimeOffset? statusUpdateTime, TwinConnectionState? connectionState, DateTimeOffset? lastActivityTime, int? cloudToDeviceMessageCount, TwinAuthenticationType? authenticationType, X509Thumbprint x509Thumbprint, DeviceCapabilities capabilities, string deviceScope, IList parentScopes) { DeviceId = deviceId; @@ -59,27 +59,27 @@ internal TwinData(string deviceId, string moduleId, IDictionary ParentScopes = parentScopes; } - /// The deviceId uniquely identifies the device in the IoT hub's identity registry. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. + /// The unique identifier of the device in the IoT hub's identity registry. It is a case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars, and the following special characters {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. public string DeviceId { get; set; } - /// Gets and sets the Module Id. + /// The unique identifier of the module in the IoT hub's identity registry. It is a case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars, and the following special characters {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. public string ModuleId { get; set; } - /// A JSON document read and written by the solution back end. Tags are not visible to device apps. + /// A collection of key-value pairs read and written by the solution back end. They are not visible to device apps. public IDictionary Tags { get; set; } - /// Gets and sets the Twin properties. + /// The twin's desired and reported properties. public TwinProperties Properties { get; set; } - /// Twin's ETag. + /// TODO - which operation does this affect - update tags/ properties etc?. public string Etag { get; set; } /// Version for device twin, including tags and desired properties. public long? Version { get; set; } - /// Device's ETag. + /// TODO - which operation does this affect?. public string DeviceEtag { get; set; } - /// Gets the corresponding Device's Status. + /// Flags whether a device is enabled or not. If disabled, a device cannot connect to the service. public TwinStatus? Status { get; set; } - /// Reason, if any, for the corresponding Device to be in specified Status. + /// Reason, if any, for the device's current status. public string StatusReason { get; set; } - /// Time when the corresponding Device's Status was last updated. + /// Time when the corresponding device's status was last updated. public DateTimeOffset? StatusUpdateTime { get; set; } - /// Corresponding Device's ConnectionState. + /// The device's connection state. public TwinConnectionState? ConnectionState { get; set; } /// The last time the device connected, received or sent a message. In ISO8601 datetime format in UTC, for example, 2015-01-28T16:24:48.789Z. This does not update if the device uses the HTTP/1 protocol to perform messaging operations. public DateTimeOffset? LastActivityTime { get; set; } @@ -91,7 +91,9 @@ internal TwinData(string deviceId, string moduleId, IDictionary public X509Thumbprint X509Thumbprint { get; set; } /// Status of Capabilities enabled on the device. public DeviceCapabilities Capabilities { get; set; } + /// Scope to which this device instance belongs to. public string DeviceScope { get; set; } + /// TODO: new property added - need explanation. public IList ParentScopes { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinProperties.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinProperties.cs index d0233b451e99..3eed315ac486 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinProperties.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinProperties.cs @@ -9,7 +9,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// Represents Twin properties. + /// The twin's desired and reported properties. The maximum depth of twin property objects is 10. public partial class TwinProperties { /// Initializes a new instance of TwinProperties. @@ -18,17 +18,17 @@ public TwinProperties() } /// Initializes a new instance of TwinProperties. - /// Used in conjunction with reported properties to synchronize device configuration or condition. Desired properties can only be set by the solution back end and can be read by the device app. The device app can also be notified in real time of changes on the desired properties. - /// Used in conjunction with desired properties to synchronize device configuration or condition. Reported properties can only be set by the device app and can be read and queried by the solution back end. + /// Properties that are set by the solution back end and read by the device. + /// Properties that are set by the device, and read and queried by the solution back end. internal TwinProperties(IDictionary desired, IDictionary reported) { Desired = desired; Reported = reported; } - /// Used in conjunction with reported properties to synchronize device configuration or condition. Desired properties can only be set by the solution back end and can be read by the device app. The device app can also be notified in real time of changes on the desired properties. + /// Properties that are set by the solution back end and read by the device. public IDictionary Desired { get; set; } - /// Used in conjunction with desired properties to synchronize device configuration or condition. Reported properties can only be set by the device app and can be read and queried by the solution back end. + /// Properties that are set by the device, and read and queried by the solution back end. public IDictionary Reported { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinStatus.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinStatus.cs index 70d4ef266982..981271daf548 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinStatus.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/TwinStatus.cs @@ -10,7 +10,7 @@ namespace Azure.Iot.Hub.Service.Models { - /// Gets the corresponding Device's Status. + /// Flags whether a device is enabled or not. If disabled, a device cannot connect to the service. public readonly partial struct TwinStatus : IEquatable { private readonly string _value; diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/X509Thumbprint.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/X509Thumbprint.cs index 1bf166af1431..196aa9f5f509 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/X509Thumbprint.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/Models/X509Thumbprint.cs @@ -16,15 +16,17 @@ public X509Thumbprint() } /// Initializes a new instance of X509Thumbprint. - /// . - /// . + /// Gets and sets the X509 client certificate primary thumbprint. + /// Gets and sets the X509 client certificate secondary thumbprint. internal X509Thumbprint(string primaryThumbprint, string secondaryThumbprint) { PrimaryThumbprint = primaryThumbprint; SecondaryThumbprint = secondaryThumbprint; } + /// Gets and sets the X509 client certificate primary thumbprint. public string PrimaryThumbprint { get; set; } + /// Gets and sets the X509 client certificate secondary thumbprint. public string SecondaryThumbprint { get; set; } } } diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerClient.cs index 96eac83eb39d..957ef39f5101 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerClient.cs @@ -33,7 +33,7 @@ internal RegistryManagerClient(ClientDiagnostics clientDiagnostics, HttpPipeline _pipeline = pipeline; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get statistics about device identities in the IoT hub’s identity registry, such as total device count. /// The cancellation token to use. public virtual async Task> GetDeviceStatisticsAsync(CancellationToken cancellationToken = default) { @@ -50,7 +50,7 @@ public virtual async Task> GetDeviceStatisticsAsync } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get statistics about device identities in the IoT hub’s identity registry, such as total device count. /// The cancellation token to use. public virtual Response GetDeviceStatistics(CancellationToken cancellationToken = default) { @@ -67,7 +67,7 @@ public virtual Response GetDeviceStatistics(CancellationToke } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Retrieves device statistics for this IoT hub, such as connected device count. /// The cancellation token to use. public virtual async Task> GetServiceStatisticsAsync(CancellationToken cancellationToken = default) { @@ -84,7 +84,7 @@ public virtual async Task> GetServiceStatisticsAsync } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Retrieves device statistics for this IoT hub, such as connected device count. /// The cancellation token to use. public virtual Response GetServiceStatistics(CancellationToken cancellationToken = default) { @@ -101,7 +101,7 @@ public virtual Response GetServiceStatistics(CancellationToke } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query API to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information. /// This parameter when specified, defines the maximum number of device identities that are returned. Any value outside the range of 1-1000 is considered to be 1000. /// The cancellation token to use. public virtual async Task>> GetDevicesAsync(int? top = null, CancellationToken cancellationToken = default) @@ -119,7 +119,7 @@ public virtual async Task>> GetDevicesAsy } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query API to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information. /// This parameter when specified, defines the maximum number of device identities that are returned. Any value outside the range of 1-1000 is considered to be 1000. /// The cancellation token to use. public virtual Response> GetDevices(int? top = null, CancellationToken cancellationToken = default) @@ -137,7 +137,7 @@ public virtual Response> GetDevices(int? top = nul } } - /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). /// The ArrayOfExportImportDevice to use. /// The cancellation token to use. public virtual async Task> BulkDeviceCrudAsync(IEnumerable devices, CancellationToken cancellationToken = default) @@ -155,7 +155,7 @@ public virtual async Task> BulkDeviceCrudA } } - /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). /// The ArrayOfExportImportDevice to use. /// The cancellation token to use. public virtual Response BulkDeviceCrud(IEnumerable devices, CancellationToken cancellationToken = default) @@ -173,10 +173,10 @@ public virtual Response BulkDeviceCrud(IEnumerable< } } - /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The QuerySpecification to use. - /// The String to use. - /// The String to use. + /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination is supported. This returns information about device twins only. + /// The query string to run. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The continuation token to get the next page of results. + /// The maximum number of items to return per page. The service may use a different value if the value specified is not acceptable. /// The cancellation token to use. public virtual async Task>> QueryIotHubAsync(QuerySpecification querySpecification, string xMsContinuation = null, string xMsMaxItemCount = null, CancellationToken cancellationToken = default) { @@ -193,10 +193,10 @@ public virtual async Task>> QueryIotHubAsync(Qu } } - /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The QuerySpecification to use. - /// The String to use. - /// The String to use. + /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination is supported. This returns information about device twins only. + /// The query string to run. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The continuation token to get the next page of results. + /// The maximum number of items to return per page. The service may use a different value if the value specified is not acceptable. /// The cancellation token to use. public virtual Response> QueryIotHub(QuerySpecification querySpecification, string xMsContinuation = null, string xMsMaxItemCount = null, CancellationToken cancellationToken = default) { @@ -213,8 +213,8 @@ public virtual Response> QueryIotHub(QuerySpecification } } - /// Retrieve a device from the identity registry of an IoT hub. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get a device from the identity registry of an IoT hub. + /// The unique identifier of the device to retrieve. /// The cancellation token to use. public virtual async Task> GetDeviceAsync(string id, CancellationToken cancellationToken = default) { @@ -231,8 +231,8 @@ public virtual async Task> GetDeviceAsync(string id, Ca } } - /// Retrieve a device from the identity registry of an IoT hub. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get a device from the identity registry of an IoT hub. + /// The unique identifier of the device to retrieve. /// The cancellation token to use. public virtual Response GetDevice(string id, CancellationToken cancellationToken = default) { @@ -249,10 +249,10 @@ public virtual Response GetDevice(string id, CancellationToken c } } - /// Create or update the identity of a device in the identity registry of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that generationId and deviceId cannot be updated by the user. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The Device to use. - /// The String to use. + /// Create or update the identity of a device in the identity registry of an IoT hub. + /// The unique identifier of the device to create. + /// The contents of the device to create. + /// A string representing a weak ETag for the device identity, as per RFC7232. Should not be set when creating a device, but may be set when updating a device. /// The cancellation token to use. public virtual async Task> CreateOrUpdateDeviceAsync(string id, DeviceIdentity device, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -269,10 +269,10 @@ public virtual async Task> CreateOrUpdateDeviceAsync(st } } - /// Create or update the identity of a device in the identity registry of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that generationId and deviceId cannot be updated by the user. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The Device to use. - /// The String to use. + /// Create or update the identity of a device in the identity registry of an IoT hub. + /// The unique identifier of the device to create. + /// The contents of the device to create. + /// A string representing a weak ETag for the device identity, as per RFC7232. Should not be set when creating a device, but may be set when updating a device. /// The cancellation token to use. public virtual Response CreateOrUpdateDevice(string id, DeviceIdentity device, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -289,9 +289,9 @@ public virtual Response CreateOrUpdateDevice(string id, DeviceId } } - /// Delete the identity of a device from the identity registry of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The String to use. + /// Delete the identity of a device from the identity registry of an IoT hub. + /// The unique identifier of the device to delete. + /// A string representing a weak ETag for the device identity, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the device identity has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public virtual async Task DeleteDeviceAsync(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -308,9 +308,9 @@ public virtual async Task DeleteDeviceAsync(string id, string ifMatch } } - /// Delete the identity of a device from the identity registry of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The String to use. + /// Delete the identity of a device from the identity registry of an IoT hub. + /// The unique identifier of the device to delete. + /// A string representing a weak ETag for the device identity, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the device identity has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public virtual Response DeleteDevice(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -327,8 +327,8 @@ public virtual Response DeleteDevice(string id, string ifMatch = null, Cancellat } } - /// Deletes all the pending commands for this device from the IoT hub For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Deletes all the pending commands for this device from the IoT hub. + /// The unique identifier of the device. /// The cancellation token to use. public virtual async Task> PurgeCommandQueueAsync(string id, CancellationToken cancellationToken = default) { @@ -345,8 +345,8 @@ public virtual async Task> PurgeCommandQueueAs } } - /// Deletes all the pending commands for this device from the IoT hub For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Deletes all the pending commands for this device from the IoT hub. + /// The unique identifier of the device. /// The cancellation token to use. public virtual Response PurgeCommandQueue(string id, CancellationToken cancellationToken = default) { @@ -363,8 +363,8 @@ public virtual Response PurgeCommandQueue(string id, Ca } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get all the module identities of the device. + /// The unique identifier of the device. /// The cancellation token to use. public virtual async Task>> GetModulesOnDeviceAsync(string id, CancellationToken cancellationToken = default) { @@ -381,8 +381,8 @@ public virtual async Task>> GetModulesOnD } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get all the module identities of the device. + /// The unique identifier of the device. /// The cancellation token to use. public virtual Response> GetModulesOnDevice(string id, CancellationToken cancellationToken = default) { @@ -399,9 +399,9 @@ public virtual Response> GetModulesOnDevice(string } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Get the specified module identity of the device. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public virtual async Task> GetModuleAsync(string id, string mid, CancellationToken cancellationToken = default) { @@ -418,9 +418,9 @@ public virtual async Task> GetModuleAsync(string id, st } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Get the specified module identity of the device. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public virtual Response GetModule(string id, string mid, CancellationToken cancellationToken = default) { @@ -437,11 +437,11 @@ public virtual Response GetModule(string id, string mid, Cancell } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The Module to use. - /// The String to use. + /// Create or update the module identity for device in IoT hub. The moduleId and generation cannot be updated by the user. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The module identity. + /// A string representing a weak ETag for the module, as per RFC7232. Should not be set when creating module, but may be set when updating a module. /// The cancellation token to use. public virtual async Task> CreateOrUpdateModuleAsync(string id, string mid, ModuleIdentity module, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -458,11 +458,11 @@ public virtual async Task> CreateOrUpdateModuleAsync(st } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The Module to use. - /// The String to use. + /// Create or update the module identity for device in IoT hub. The moduleId and generation cannot be updated by the user. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The module identity. + /// A string representing a weak ETag for the module, as per RFC7232. Should not be set when creating module, but may be set when updating a module. /// The cancellation token to use. public virtual Response CreateOrUpdateModule(string id, string mid, ModuleIdentity module, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -479,10 +479,10 @@ public virtual Response CreateOrUpdateModule(string id, string m } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The String to use. + /// Delete the module identity for device of an IoT hub. + /// The unique identifier of the deivce. + /// The unique identifier of the module. + /// A string representing a weak ETag for the module, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the module has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public virtual async Task DeleteModuleAsync(string id, string mid, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -499,10 +499,10 @@ public virtual async Task DeleteModuleAsync(string id, string mid, str } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The String to use. + /// Delete the module identity for device of an IoT hub. + /// The unique identifier of the deivce. + /// The unique identifier of the module. + /// A string representing a weak ETag for the module, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the module has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public virtual Response DeleteModule(string id, string mid, string ifMatch = null, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerRestClient.cs index 82297cd61b15..cf9ac1ae2e42 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/RegistryManagerRestClient.cs @@ -55,7 +55,7 @@ internal HttpMessage CreateGetDeviceStatisticsRequest() return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get statistics about device identities in the IoT hub’s identity registry, such as total device count. /// The cancellation token to use. public async ValueTask> GetDeviceStatisticsAsync(CancellationToken cancellationToken = default) { @@ -82,7 +82,7 @@ public async ValueTask> GetDeviceStatisticsAsync(Ca } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get statistics about device identities in the IoT hub’s identity registry, such as total device count. /// The cancellation token to use. public Response GetDeviceStatistics(CancellationToken cancellationToken = default) { @@ -122,7 +122,7 @@ internal HttpMessage CreateGetServiceStatisticsRequest() return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Retrieves device statistics for this IoT hub, such as connected device count. /// The cancellation token to use. public async ValueTask> GetServiceStatisticsAsync(CancellationToken cancellationToken = default) { @@ -149,7 +149,7 @@ public async ValueTask> GetServiceStatisticsAsync(Ca } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Retrieves device statistics for this IoT hub, such as connected device count. /// The cancellation token to use. public Response GetServiceStatistics(CancellationToken cancellationToken = default) { @@ -193,7 +193,7 @@ internal HttpMessage CreateGetDevicesRequest(int? top) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query API to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information. /// This parameter when specified, defines the maximum number of device identities that are returned. Any value outside the range of 1-1000 is considered to be 1000. /// The cancellation token to use. public async ValueTask>> GetDevicesAsync(int? top = null, CancellationToken cancellationToken = default) @@ -233,7 +233,7 @@ public async ValueTask>> GetDevicesAsync( } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query API to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information. /// This parameter when specified, defines the maximum number of device identities that are returned. Any value outside the range of 1-1000 is considered to be 1000. /// The cancellation token to use. public Response> GetDevices(int? top = null, CancellationToken cancellationToken = default) @@ -295,7 +295,7 @@ internal HttpMessage CreateBulkDeviceCrudRequest(IEnumerable return message; } - /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). /// The ArrayOfExportImportDevice to use. /// The cancellation token to use. public async ValueTask> BulkDeviceCrudAsync(IEnumerable devices, CancellationToken cancellationToken = default) @@ -329,7 +329,7 @@ public async ValueTask> BulkDeviceCrudAsyn } } - /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. + /// Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). /// The ArrayOfExportImportDevice to use. /// The cancellation token to use. public Response BulkDeviceCrud(IEnumerable devices, CancellationToken cancellationToken = default) @@ -388,10 +388,10 @@ internal HttpMessage CreateQueryIotHubRequest(QuerySpecification querySpecificat return message; } - /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The QuerySpecification to use. - /// The String to use. - /// The String to use. + /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination is supported. This returns information about device twins only. + /// The query string to run. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The continuation token to get the next page of results. + /// The maximum number of items to return per page. The service may use a different value if the value specified is not acceptable. /// The cancellation token to use. public async ValueTask, RegistryManagerQueryIotHubHeaders>> QueryIotHubAsync(QuerySpecification querySpecification, string xMsContinuation = null, string xMsMaxItemCount = null, CancellationToken cancellationToken = default) { @@ -436,10 +436,10 @@ public async ValueTask, RegistryMana } } - /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// The QuerySpecification to use. - /// The String to use. - /// The String to use. + /// Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination is supported. This returns information about device twins only. + /// The query string to run. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. + /// The continuation token to get the next page of results. + /// The maximum number of items to return per page. The service may use a different value if the value specified is not acceptable. /// The cancellation token to use. public ResponseWithHeaders, RegistryManagerQueryIotHubHeaders> QueryIotHub(QuerySpecification querySpecification, string xMsContinuation = null, string xMsMaxItemCount = null, CancellationToken cancellationToken = default) { @@ -498,8 +498,8 @@ internal HttpMessage CreateGetDeviceRequest(string id) return message; } - /// Retrieve a device from the identity registry of an IoT hub. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get a device from the identity registry of an IoT hub. + /// The unique identifier of the device to retrieve. /// The cancellation token to use. public async ValueTask> GetDeviceAsync(string id, CancellationToken cancellationToken = default) { @@ -531,8 +531,8 @@ public async ValueTask> GetDeviceAsync(string id, Cance } } - /// Retrieve a device from the identity registry of an IoT hub. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get a device from the identity registry of an IoT hub. + /// The unique identifier of the device to retrieve. /// The cancellation token to use. public Response GetDevice(string id, CancellationToken cancellationToken = default) { @@ -586,10 +586,10 @@ internal HttpMessage CreateCreateOrUpdateDeviceRequest(string id, DeviceIdentity return message; } - /// Create or update the identity of a device in the identity registry of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that generationId and deviceId cannot be updated by the user. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The Device to use. - /// The String to use. + /// Create or update the identity of a device in the identity registry of an IoT hub. + /// The unique identifier of the device to create. + /// The contents of the device to create. + /// A string representing a weak ETag for the device identity, as per RFC7232. Should not be set when creating a device, but may be set when updating a device. /// The cancellation token to use. public async ValueTask> CreateOrUpdateDeviceAsync(string id, DeviceIdentity device, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -625,10 +625,10 @@ public async ValueTask> CreateOrUpdateDeviceAsync(strin } } - /// Create or update the identity of a device in the identity registry of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that generationId and deviceId cannot be updated by the user. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The Device to use. - /// The String to use. + /// Create or update the identity of a device in the identity registry of an IoT hub. + /// The unique identifier of the device to create. + /// The contents of the device to create. + /// A string representing a weak ETag for the device identity, as per RFC7232. Should not be set when creating a device, but may be set when updating a device. /// The cancellation token to use. public Response CreateOrUpdateDevice(string id, DeviceIdentity device, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -682,9 +682,9 @@ internal HttpMessage CreateDeleteDeviceRequest(string id, string ifMatch) return message; } - /// Delete the identity of a device from the identity registry of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The String to use. + /// Delete the identity of a device from the identity registry of an IoT hub. + /// The unique identifier of the device to delete. + /// A string representing a weak ETag for the device identity, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the device identity has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public async ValueTask DeleteDeviceAsync(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -704,9 +704,9 @@ public async ValueTask DeleteDeviceAsync(string id, string ifMatch = n } } - /// Delete the identity of a device from the identity registry of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// The String to use. + /// Delete the identity of a device from the identity registry of an IoT hub. + /// The unique identifier of the device to delete. + /// A string representing a weak ETag for the device identity, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the device identity has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public Response DeleteDevice(string id, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -741,8 +741,8 @@ internal HttpMessage CreatePurgeCommandQueueRequest(string id) return message; } - /// Deletes all the pending commands for this device from the IoT hub For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Deletes all the pending commands for this device from the IoT hub. + /// The unique identifier of the device. /// The cancellation token to use. public async ValueTask> PurgeCommandQueueAsync(string id, CancellationToken cancellationToken = default) { @@ -774,8 +774,8 @@ public async ValueTask> PurgeCommandQueueAsync } } - /// Deletes all the pending commands for this device from the IoT hub For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Deletes all the pending commands for this device from the IoT hub. + /// The unique identifier of the device. /// The cancellation token to use. public Response PurgeCommandQueue(string id, CancellationToken cancellationToken = default) { @@ -822,8 +822,8 @@ internal HttpMessage CreateGetModulesOnDeviceRequest(string id) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get all the module identities of the device. + /// The unique identifier of the device. /// The cancellation token to use. public async ValueTask>> GetModulesOnDeviceAsync(string id, CancellationToken cancellationToken = default) { @@ -867,8 +867,8 @@ public async ValueTask>> GetModulesOnDevi } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Get all the module identities of the device. + /// The unique identifier of the device. /// The cancellation token to use. public Response> GetModulesOnDevice(string id, CancellationToken cancellationToken = default) { @@ -928,9 +928,9 @@ internal HttpMessage CreateGetModuleRequest(string id, string mid) return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Get the specified module identity of the device. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public async ValueTask> GetModuleAsync(string id, string mid, CancellationToken cancellationToken = default) { @@ -966,9 +966,9 @@ public async ValueTask> GetModuleAsync(string id, strin } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Get the specified module identity of the device. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public Response GetModule(string id, string mid, CancellationToken cancellationToken = default) { @@ -1028,11 +1028,11 @@ internal HttpMessage CreateCreateOrUpdateModuleRequest(string id, string mid, Mo return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The Module to use. - /// The String to use. + /// Create or update the module identity for device in IoT hub. The moduleId and generation cannot be updated by the user. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The module identity. + /// A string representing a weak ETag for the module, as per RFC7232. Should not be set when creating module, but may be set when updating a module. /// The cancellation token to use. public async ValueTask> CreateOrUpdateModuleAsync(string id, string mid, ModuleIdentity module, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -1073,11 +1073,11 @@ public async ValueTask> CreateOrUpdateModuleAsync(strin } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The Module to use. - /// The String to use. + /// Create or update the module identity for device in IoT hub. The moduleId and generation cannot be updated by the user. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The module identity. + /// A string representing a weak ETag for the module, as per RFC7232. Should not be set when creating module, but may be set when updating a module. /// The cancellation token to use. public Response CreateOrUpdateModule(string id, string mid, ModuleIdentity module, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -1138,10 +1138,10 @@ internal HttpMessage CreateDeleteModuleRequest(string id, string mid, string ifM return message; } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The String to use. + /// Delete the module identity for device of an IoT hub. + /// The unique identifier of the deivce. + /// The unique identifier of the module. + /// A string representing a weak ETag for the module, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the module has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public async ValueTask DeleteModuleAsync(string id, string mid, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -1165,10 +1165,10 @@ public async ValueTask DeleteModuleAsync(string id, string mid, string } } - /// For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// The String to use. + /// Delete the module identity for device of an IoT hub. + /// The unique identifier of the deivce. + /// The unique identifier of the module. + /// A string representing a weak ETag for the module, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the module has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*). /// The cancellation token to use. public Response DeleteModule(string id, string mid, string ifMatch = null, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinClient.cs index 77a980966f99..ef8456971542 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinClient.cs @@ -32,8 +32,8 @@ internal TwinClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, _pipeline = pipeline; } - /// Gets a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Gets the device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. /// The cancellation token to use. public virtual async Task> GetDeviceTwinAsync(string id, CancellationToken cancellationToken = default) { @@ -50,8 +50,8 @@ public virtual async Task> GetDeviceTwinAsync(string id, Canc } } - /// Gets a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Gets the device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. /// The cancellation token to use. public virtual Response GetDeviceTwin(string id, CancellationToken cancellationToken = default) { @@ -68,10 +68,10 @@ public virtual Response GetDeviceTwin(string id, CancellationToken can } } - /// Replaces a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object that will replace the current device twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public virtual async Task> ReplaceDeviceTwinAsync(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -88,10 +88,10 @@ public virtual async Task> ReplaceDeviceTwinAsync(string id, } } - /// Replaces a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object that will replace the current device twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public virtual Response ReplaceDeviceTwin(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -108,10 +108,10 @@ public virtual Response ReplaceDeviceTwin(string id, TwinData deviceTw } } - /// Updates a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Updates the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public virtual async Task> UpdateDeviceTwinAsync(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -128,10 +128,10 @@ public virtual async Task> UpdateDeviceTwinAsync(string id, T } } - /// Updates a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Updates the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public virtual Response UpdateDeviceTwin(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -148,9 +148,9 @@ public virtual Response UpdateDeviceTwin(string id, TwinData deviceTwi } } - /// Gets a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Gets the module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public virtual async Task> GetModuleTwinAsync(string id, string mid, CancellationToken cancellationToken = default) { @@ -167,9 +167,9 @@ public virtual async Task> GetModuleTwinAsync(string id, stri } } - /// Gets a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Gets the module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public virtual Response GetModuleTwin(string id, string mid, CancellationToken cancellationToken = default) { @@ -186,11 +186,11 @@ public virtual Response GetModuleTwin(string id, string mid, Cancellat } } - /// Replaces a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object that will replace the current module twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public virtual async Task> ReplaceModuleTwinAsync(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -207,11 +207,11 @@ public virtual async Task> ReplaceModuleTwinAsync(string id, } } - /// Replaces a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object that will replace the current module twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public virtual Response ReplaceModuleTwin(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -228,11 +228,11 @@ public virtual Response ReplaceModuleTwin(string id, string mid, TwinD } } - /// Updates a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin information. - /// The String to use. + /// Updates the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public virtual async Task> UpdateModuleTwinAsync(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -249,11 +249,11 @@ public virtual async Task> UpdateModuleTwinAsync(string id, s } } - /// Updates a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin information. - /// The String to use. + /// Updates the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public virtual Response UpdateModuleTwin(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinRestClient.cs b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinRestClient.cs index 05a7928c42d9..af1371aa4fa0 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinRestClient.cs +++ b/sdk/iot/Azure.Iot.Hub.Service/src/Generated/TwinRestClient.cs @@ -55,8 +55,8 @@ internal HttpMessage CreateGetDeviceTwinRequest(string id) return message; } - /// Gets a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Gets the device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. /// The cancellation token to use. public async ValueTask> GetDeviceTwinAsync(string id, CancellationToken cancellationToken = default) { @@ -88,8 +88,8 @@ public async ValueTask> GetDeviceTwinAsync(string id, Cancell } } - /// Gets a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. + /// Gets the device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. /// The cancellation token to use. public Response GetDeviceTwin(string id, CancellationToken cancellationToken = default) { @@ -143,10 +143,10 @@ internal HttpMessage CreateReplaceDeviceTwinRequest(string id, TwinData deviceTw return message; } - /// Replaces a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object that will replace the current device twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public async ValueTask> ReplaceDeviceTwinAsync(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -182,10 +182,10 @@ public async ValueTask> ReplaceDeviceTwinAsync(string id, Twi } } - /// Replaces a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object that will replace the current device twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public Response ReplaceDeviceTwin(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -243,10 +243,10 @@ internal HttpMessage CreateUpdateDeviceTwinRequest(string id, TwinData deviceTwi return message; } - /// Updates a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Updates the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public async ValueTask> UpdateDeviceTwinAsync(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -282,10 +282,10 @@ public async ValueTask> UpdateDeviceTwinAsync(string id, Twin } } - /// Updates a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Device twin info. - /// The String to use. + /// Updates the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public Response UpdateDeviceTwin(string id, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -337,9 +337,9 @@ internal HttpMessage CreateGetModuleTwinRequest(string id, string mid) return message; } - /// Gets a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Gets the module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public async ValueTask> GetModuleTwinAsync(string id, string mid, CancellationToken cancellationToken = default) { @@ -375,9 +375,9 @@ public async ValueTask> GetModuleTwinAsync(string id, string } } - /// Gets a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. + /// Gets the module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. /// The cancellation token to use. public Response GetModuleTwin(string id, string mid, CancellationToken cancellationToken = default) { @@ -437,11 +437,11 @@ internal HttpMessage CreateReplaceModuleTwinRequest(string id, string mid, TwinD return message; } - /// Replaces a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object that will replace the current module twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public async ValueTask> ReplaceModuleTwinAsync(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -481,11 +481,11 @@ public async ValueTask> ReplaceModuleTwinAsync(string id, str } } - /// Replaces a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin info. - /// The String to use. + /// Replaces the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object that will replace the current module twin. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out. /// The cancellation token to use. public Response ReplaceModuleTwin(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -549,11 +549,11 @@ internal HttpMessage CreateUpdateModuleTwinRequest(string id, string mid, TwinDa return message; } - /// Updates a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin information. - /// The String to use. + /// Updates the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public async ValueTask> UpdateModuleTwinAsync(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { @@ -593,11 +593,11 @@ public async ValueTask> UpdateModuleTwinAsync(string id, stri } } - /// Updates a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'. - /// Device ID. - /// Module ID. - /// Device twin information. - /// The String to use. + /// Updates the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. + /// The unique identifier of the device. + /// The unique identifier of the module. + /// The twin object containing the tags and desired properties to be updated. + /// A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out. /// The cancellation token to use. public Response UpdateModuleTwin(string id, string mid, TwinData deviceTwinInfo, string ifMatch = null, CancellationToken cancellationToken = default) { diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/swagger/iothubservice.json b/sdk/iot/Azure.Iot.Hub.Service/src/swagger/iothubservice.json index 54e5316c9b53..3e3475b7affa 100644 --- a/sdk/iot/Azure.Iot.Hub.Service/src/swagger/iothubservice.json +++ b/sdk/iot/Azure.Iot.Hub.Service/src/swagger/iothubservice.json @@ -11,8 +11,7 @@ "paths": { "/configurations/{id}": { "get": { - "summary": "Retrieve a configuration for Iot Hub devices and modules by it identifier.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get a configuration on IoT Hub for automatic device/module management.", "operationId": "Configuration_Get", "consumes": [], "produces": [ @@ -21,6 +20,7 @@ "parameters": [ { "name": "id", + "description": "The unique identifier of the configuration.", "in": "path", "required": true, "type": "string" @@ -31,80 +31,83 @@ ], "responses": { "200": { - "description": "Returns the Configuration object", + "description": "Returns the Configuration.", "schema": { "$ref": "#/definitions/Configuration" } } } }, - "put": { - "summary": "Create or update the configuration for devices or modules of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that configuration Id and Content cannot be updated by the user.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", - "operationId": "Configuration_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "configuration", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Configuration" - } - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Returns the updated Configuration object", - "schema": { - "$ref": "#/definitions/Configuration" - } - }, - "201": { - "description": "Returns the created Configuration object", - "schema": { - "$ref": "#/definitions/Configuration" + "put": { + "description": "Create or update a configuration on IoT Hub for automatic device/module management. Configuration Id and Content cannot be updated.", + "operationId": "Configuration_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "description": "The unique identifier of the configuration.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "configuration", + "description": "The configuration to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + { + "name": "If-Match", + "description": "A string representing a weak ETag for configuration, as per RFC7232. Should not be set when creating a configuration, but may be set when updating a configuration.", + "in": "header", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Returns the updated configuration", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "201": { + "description": "Returns the created configuration", + "schema": { + "$ref": "#/definitions/Configuration" + } + } } - } - } - }, + }, "delete": { - "summary": "Delete the configuration for devices or modules of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Delete a configuration on IoT Hub for automatic device/module management", "operationId": "Configuration_Delete", "consumes": [], "produces": [ "application/json" ], "parameters": [ - { - "name": "id", - "in": "path", - "required": true, - "type": "string" - }, + { + "name": "id", + "description": "The unique identifier of the configuration.", + "in": "path", + "required": true, + "type": "string" + }, { "name": "If-Match", + "description": "A string representing a weak ETag for configuration, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the configuration has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*).", "in": "header", "required": false, "type": "string" @@ -122,28 +125,28 @@ }, "/configurations": { "get": { - "summary": "Get multiple configurations for devices or modules of an IoT Hub. Returns the specified number of configurations for Iot Hub. Pagination is not supported.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get multiple configurations on IoT Hub for automatic device/module management", "operationId": "Configuration_GetConfigurations", "consumes": [], "produces": [ "application/json" ], "parameters": [ - { - "name": "top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, + { + "name": "top", + "description": "Number of configurations to retrieve. TODO: Ask service team if this value can be overriden if too large", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { - "description": "Returns the list of Configuration objects", + "description": "Returns a list of configurations. Pagination is not supported.", "schema": { "type": "array", "items": { @@ -156,8 +159,7 @@ }, "/configurations/testQueries": { "post": { - "summary": "Validates the target condition query and custom metric queries for a configuration.", - "description": "Validates the target condition query and custom metric queries for a configuration. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Validate the target condition and custom metric queries for a configuration on IoT Hub.", "operationId": "Configuration_TestQueries", "consumes": [ "application/json" @@ -168,6 +170,7 @@ "parameters": [ { "name": "input", + "description": "Configuration query for target condition or custom metrics.", "in": "body", "required": true, "schema": { @@ -180,7 +183,7 @@ ], "responses": { "200": { - "description": "Returns the ConfigurationQueriesTestResponse object.", + "description": "Returns the configuration queries test response.", "schema": { "$ref": "#/definitions/ConfigurationQueriesTestResponse" } @@ -190,8 +193,7 @@ }, "/statistics/devices": { "get": { - "summary": "Retrieves statistics about device identities in the IoT hub’s identity registry.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get statistics about device identities in the IoT hub’s identity registry, such as total device count.", "operationId": "RegistryManager_GetDeviceStatistics", "consumes": [], "produces": [ @@ -214,8 +216,7 @@ }, "/statistics/service": { "get": { - "summary": "Retrieves service statistics for this IoT hub’s identity registry.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Retrieves device statistics for this IoT hub, such as connected device count.", "operationId": "RegistryManager_GetServiceStatistics", "consumes": [], "produces": [ @@ -238,8 +239,7 @@ }, "/devices": { "get": { - "summary": "Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query language to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get the identities of multiple devices from the IoT hub identity registry. Not recommended. Use the IoT Hub query API to retrieve device twin and device identity information. See https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub and https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language for more information.", "operationId": "RegistryManager_GetDevices", "consumes": [], "produces": [ @@ -271,8 +271,7 @@ } }, "post": { - "summary": "Create, update, or delete the identities of multiple devices from the IoT hub identity registry.", - "description": "Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Create, update, or delete the identiies of multiple devices from the IoT hub identity registry. A device identity can be specified only once in the list. Different operations (create, update, delete) on different devices are allowed. A maximum of 100 devices can be specified per invocation. For large scale operations, consider using the import feature using blob storage(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities).", "operationId": "RegistryManager_BulkDeviceCRUD", "consumes": [ "application/json" @@ -289,7 +288,8 @@ "type": "array", "items": { "$ref": "#/definitions/ExportImportDevice" - } + }, + "description": "The set of registry operations to perform." } }, { @@ -314,8 +314,7 @@ }, "/devices/query": { "post": { - "summary": "Query an IoT hub to retrieve information regarding device twins using a SQL-like language.", - "description": "Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about device twins only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Query an IoT hub to retrieve information regarding device twins using a SQL-like language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination is supported. This returns information about device twins only.", "operationId": "RegistryManager_QueryIotHub", "consumes": [ "application/json" @@ -330,7 +329,8 @@ "required": true, "schema": { "$ref": "#/definitions/QuerySpecification" - } + }, + "description": "The query string to run. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information." }, { "$ref": "#/parameters/api-version" @@ -339,13 +339,15 @@ "name": "x-ms-continuation", "in": "header", "required": false, - "type": "string" + "type": "string", + "description": "The continuation token to get the next page of results." }, { "name": "x-ms-max-item-count", "in": "header", "required": false, - "type": "string" + "type": "string", + "description": "The maximum number of items to return per page. The service may use a different value if the value specified is not acceptable." } ], "responses": { @@ -373,8 +375,7 @@ }, "/devices/{id}": { "get": { - "summary": "Retrieve a device from the identity registry of an IoT hub.", - "description": "Retrieve a device from the identity registry of an IoT hub. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get a device from the identity registry of an IoT hub.", "operationId": "RegistryManager_GetDevice", "consumes": [], "produces": [ @@ -384,7 +385,7 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device to retrieve.", "required": true, "type": "string" }, @@ -394,7 +395,7 @@ ], "responses": { "200": { - "description": "Returns the Device object", + "description": "Returns the Device.", "schema": { "$ref": "#/definitions/Device" } @@ -402,8 +403,7 @@ } }, "put": { - "summary": "Create or update the identity of a device in the identity registry of an IoT hub.", - "description": "Create or update the identity of a device in the identity registry of an IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that generationId and deviceId cannot be updated by the user. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Create or update the identity of a device in the identity registry of an IoT hub.", "operationId": "RegistryManager_CreateOrUpdateDevice", "consumes": [ "application/json" @@ -415,7 +415,7 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device to create", "required": true, "type": "string" }, @@ -425,13 +425,15 @@ "required": true, "schema": { "$ref": "#/definitions/Device" - } + }, + "description": "The contents of the device to create." }, { "name": "If-Match", "in": "header", "required": false, - "type": "string" + "type": "string", + "description": "A string representing a weak ETag for the device identity, as per RFC7232. Should not be set when creating a device, but may be set when updating a device." }, { "$ref": "#/parameters/api-version" @@ -439,7 +441,7 @@ ], "responses": { "200": { - "description": "Returns the Device object", + "description": "Returns the Device", "schema": { "$ref": "#/definitions/Device" } @@ -447,8 +449,7 @@ } }, "delete": { - "summary": "Delete the identity of a device from the identity registry of an IoT hub.", - "description": "Delete the identity of a device from the identity registry of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Delete the identity of a device from the identity registry of an IoT hub.", "operationId": "RegistryManager_DeleteDevice", "consumes": [], "produces": [ @@ -458,7 +459,7 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device to delete.", "required": true, "type": "string" }, @@ -466,7 +467,8 @@ "name": "If-Match", "in": "header", "required": false, - "type": "string" + "type": "string", + "description": "A string representing a weak ETag for the device identity, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the device identity has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*)." }, { "$ref": "#/parameters/api-version" @@ -481,8 +483,7 @@ }, "/devices/{id}/applyConfigurationContent": { "post": { - "summary": "Applies the provided configuration content to the specified edge device.", - "description": "Applies the provided configuration content to the specified edge device. Configuration content must have modules content For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Apply the provided configuration content to the specified edge device.", "operationId": "Configuration_ApplyOnEdgeDevice", "consumes": [ "application/json" @@ -493,8 +494,8 @@ "parameters": [ { "name": "id", + "description": "The unique identifier of the device.", "in": "path", - "description": "Device ID.", "required": true, "type": "string" }, @@ -526,8 +527,7 @@ }, "/jobs/create": { "post": { - "summary": "Create a new import/export job on an IoT hub.", - "description": "Create a new import/export job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Create a new import or export job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.", "operationId": "JobClient_CreateImportExportJob", "consumes": [ "application/json" @@ -551,7 +551,7 @@ ], "responses": { "200": { - "description": "Returns the JobProperties object", + "description": "Returns the JobProperties", "schema": { "$ref": "#/definitions/JobProperties" } @@ -561,8 +561,7 @@ }, "/jobs": { "get": { - "summary": "Gets the status of all import/export jobs in an iot hub", - "description": "Gets the status of all import/export jobs in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get the status of all import and export jobs in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.", "operationId": "JobClient_GetImportExportJobs", "consumes": [], "produces": [ @@ -575,7 +574,7 @@ ], "responses": { "200": { - "description": "Returns the array of JobProperties object", + "description": "Returns an array of JobProperties", "schema": { "type": "array", "items": { @@ -588,8 +587,7 @@ }, "/jobs/{id}": { "get": { - "summary": "Gets the status of an import or export job in an iot hub", - "description": "Gets the status of an import or export job in an iot hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get the status of an import or export job in IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information.", "operationId": "JobClient_GetImportExportJob", "consumes": [], "produces": [ @@ -599,7 +597,7 @@ { "name": "id", "in": "path", - "description": "Job ID.", + "description": "The unique identifier of the job.", "required": true, "type": "string" }, @@ -609,7 +607,7 @@ ], "responses": { "200": { - "description": "Returns the JobProperties object", + "description": "Returns the JobProperties", "schema": { "$ref": "#/definitions/JobProperties" } @@ -617,8 +615,7 @@ } }, "delete": { - "summary": "Cancels an import or export job in an IoT hub.", - "description": "Cancels an import or export job in an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Cancels an import or export job in IoT Hub.", "operationId": "JobClient_CancelImportExportJob", "consumes": [], "produces": [ @@ -628,7 +625,7 @@ { "name": "id", "in": "path", - "description": "Job ID.", + "description": "The unique identifier of the job.", "required": true, "type": "string" }, @@ -651,21 +648,20 @@ }, "/devices/{id}/commands": { "delete": { - "summary": "Deletes all the pending commands for this device from the IoT hub.", - "description": "Deletes all the pending commands for this device from the IoT hub For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Deletes all the pending commands for this device from the IoT hub.", "operationId": "RegistryManager_PurgeCommandQueue", "consumes": [], "produces": [ "application/json" ], "parameters": [ - { - "name": "id", - "in": "path", - "description": "Device ID.", - "required": true, - "type": "string" - }, + { + "name": "id", + "in": "path", + "description": "The unique identifier of the device.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/api-version" } @@ -681,62 +677,59 @@ } }, "/faultInjection": { - "get": { - "summary": "Get FaultInjection entity", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", - "operationId": "FaultInjection_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "typeof faultInjectionProperty", - "schema": { - "$ref": "#/definitions/FaultInjectionProperties" + "get": { + "description": "Get FaultInjection entity.", + "operationId": "FaultInjection_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FaultInjectionProperties" + } + } } - } - } - }, - "put": { - "summary": "Create or update FaultInjection entity", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", - "operationId": "FaultInjection_Set", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "value", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/FaultInjectionProperties" + }, + "put": { + "description": "Create or update FaultInjection entity.", + "operationId": "FaultInjection_Set", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "value", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FaultInjectionProperties" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK" + } } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK" - } } - } }, "/twins/{id}": { "get": { - "summary": "Gets a device twin.", - "description": "Gets a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Gets the device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.", "operationId": "Twin_GetDeviceTwin", "consumes": [], "produces": [ @@ -746,7 +739,7 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, @@ -756,7 +749,7 @@ ], "responses": { "200": { - "description": "Returns the device twin object", + "description": "OK.", "schema": { "$ref": "#/definitions/Twin" } @@ -764,8 +757,7 @@ } }, "put": { - "summary": "Replaces tags and desired properties of a device twin.", - "description": "Replaces a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Replaces the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.", "operationId": "Twin_ReplaceDeviceTwin", "consumes": [ "application/json" @@ -777,14 +769,14 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "deviceTwinInfo", "in": "body", - "description": "Device twin info", + "description": "The twin object that will replace the current device twin.", "required": true, "schema": { "$ref": "#/definitions/Twin" @@ -793,6 +785,7 @@ { "name": "If-Match", "in": "header", + "description": "A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out.", "required": false, "type": "string" }, @@ -802,7 +795,7 @@ ], "responses": { "200": { - "description": "Returns the device twin object", + "description": "The updated device twin.", "schema": { "$ref": "#/definitions/Twin" } @@ -810,8 +803,7 @@ } }, "patch": { - "summary": "Updates tags and desired properties of a device twin.", - "description": "Updates a device twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Updates the tags and desired properties of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.", "operationId": "Twin_UpdateDeviceTwin", "consumes": [ "application/json" @@ -823,14 +815,14 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "deviceTwinInfo", "in": "body", - "description": "Device twin info", + "description": "The twin object containing the tags and desired properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/Twin" @@ -839,6 +831,7 @@ { "name": "If-Match", "in": "header", + "description": "A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out.", "required": false, "type": "string" }, @@ -848,7 +841,7 @@ ], "responses": { "200": { - "description": "Returns the device twin object", + "description": "The updated device twin.", "schema": { "$ref": "#/definitions/Twin" } @@ -858,8 +851,7 @@ }, "/twins/{id}/modules/{mid}": { "get": { - "summary": "Gets a module twin.", - "description": "Gets a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Gets the module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.", "operationId": "Twin_GetModuleTwin", "consumes": [], "produces": [ @@ -869,14 +861,14 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device", "required": true, "type": "string" }, { "name": "mid", "in": "path", - "description": "Module ID.", + "description": "The unique identifier of the module", "required": true, "type": "string" }, @@ -886,7 +878,7 @@ ], "responses": { "200": { - "description": "Returns the device twin object", + "description": "The module state information.", "schema": { "$ref": "#/definitions/Twin" } @@ -894,8 +886,7 @@ } }, "put": { - "summary": "Replaces tags and desired properties of a module twin.", - "description": "Replaces a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Replaces the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.", "operationId": "Twin_ReplaceModuleTwin", "consumes": [ "application/json" @@ -907,21 +898,21 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "mid", "in": "path", - "description": "Module ID.", + "description": "The unique identifier of the module.", "required": true, "type": "string" }, { "name": "deviceTwinInfo", "in": "body", - "description": "Device twin info", + "description": "The twin object that will replace the current module twin.", "required": true, "schema": { "$ref": "#/definitions/Twin" @@ -930,6 +921,7 @@ { "name": "If-Match", "in": "header", + "description": "A string representing a weak ETag for the device twin, as per RFC7232. It determines if the replace operation should be carried out.", "required": false, "type": "string" }, @@ -939,7 +931,7 @@ ], "responses": { "200": { - "description": "Returns the device twin object", + "description": "The updated module twin.", "schema": { "$ref": "#/definitions/Twin" } @@ -947,8 +939,7 @@ } }, "patch": { - "summary": "Updates tags and desired properties of a module twin.", - "description": "Updates a module twin. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Updates the tags and desired properties of a module. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins for more information.", "operationId": "Twin_UpdateModuleTwin", "consumes": [ "application/json" @@ -960,21 +951,21 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "mid", "in": "path", - "description": "Module ID.", + "description": "The unique identifier of the module.", "required": true, "type": "string" }, { "name": "deviceTwinInfo", "in": "body", - "description": "Device twin information", + "description": "The twin object containing the tags and desired properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/Twin" @@ -983,6 +974,7 @@ { "name": "If-Match", "in": "header", + "description": "A string representing a weak ETag for the device twin, as per RFC7232. It determines if the update operation should be carried out.", "required": false, "type": "string" }, @@ -992,7 +984,7 @@ ], "responses": { "200": { - "description": "Returns the device twin object", + "description": "The updated module twin.", "schema": { "$ref": "#/definitions/Twin" } @@ -1002,8 +994,7 @@ }, "/digitalTwins/{digitalTwinId}/interfaces": { "get": { - "summary": "Gets the list of interfaces.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get the list of interfaces.", "operationId": "DigitalTwin_GetComponents", "consumes": [], "produces": [ @@ -1013,7 +1004,7 @@ { "name": "digitalTwinId", "in": "path", - "description": "Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional.", + "description": "The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional.", "required": true, "type": "string" }, @@ -1023,7 +1014,7 @@ ], "responses": { "200": { - "description": "Returns a collection of interface objects", + "description": "Returns a collection of interfaces", "schema": { "$ref": "#/definitions/DigitalTwinInterfaces" }, @@ -1037,8 +1028,7 @@ } }, "patch": { - "summary": "Updates desired properties of multiple interfaces.\r\n Example URI: \"digitalTwins/{digitalTwinId}/interfaces\"", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Updates desired properties of multiple interfaces.", "operationId": "DigitalTwin_UpdateComponent", "consumes": [ "application/json" @@ -1050,14 +1040,14 @@ { "name": "digitalTwinId", "in": "path", - "description": "Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional.", + "description": "The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional.", "required": true, "type": "string" }, { "name": "interfacesPatchInfo", "in": "body", - "description": "Multiple interfaces desired properties to update.", + "description": "The JSON representation of the update patch", "required": true, "schema": { "$ref": "#/definitions/DigitalTwinInterfacesPatch" @@ -1065,6 +1055,7 @@ }, { "name": "If-Match", + "description": "A string representing a weak ETag for digital twin, as per RFC7232", "in": "header", "required": false, "type": "string" @@ -1091,8 +1082,7 @@ }, "/digitalTwins/{digitalTwinId}/interfaces/{interfaceName}": { "get": { - "summary": "Gets the interface of given interfaceId.\r\n Example URI: \"digitalTwins/{digitalTwinId}/interfaces/{interfaceName}\"", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get the interface.", "operationId": "DigitalTwin_GetComponent", "consumes": [], "produces": [ @@ -1102,7 +1092,7 @@ { "name": "digitalTwinId", "in": "path", - "description": "Digital Twin ID. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional.", + "description": "The unique identifier of the digital twin. Format of digitalTwinId is DeviceId[~ModuleId]. ModuleId is optional.", "required": true, "type": "string" }, @@ -1119,7 +1109,7 @@ ], "responses": { "200": { - "description": "Returns interface object of given id", + "description": "Returns the interface", "schema": { "$ref": "#/definitions/DigitalTwinInterfaces" }, @@ -1135,8 +1125,7 @@ }, "/messages/serviceBound/feedback": { "get": { - "summary": "This method is used to retrieve feedback of a cloud-to-device message.", - "description": "This method is used to retrieve feedback of a cloud-to-device message See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution). For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "This method is used to retrieve feedback for cloud-to-device messages. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. This capability is only available in the standard tier IoT Hub. For more information, see [Choose the right IoT Hub tier](https://aka.ms/scaleyouriotsolution).", "operationId": "HttpRuntime_ReceiveFeedbackNotification", "consumes": [], "produces": [ @@ -1149,7 +1138,7 @@ ], "responses": { "200": { - "description": "The feedback response object" + "description": "The feedback response of a cloud-to-device message" }, "204": { "description": "No Content Sent if feedback queue is empty" @@ -1159,8 +1148,7 @@ }, "/messages/serviceBound/feedback/{lockToken}": { "delete": { - "summary": "This method completes a feedback message.", - "description": "This method completes a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when completing, a feedback message. A completed message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "This method completes a cloud-to-device feedback message. A completed message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information.", "operationId": "HttpRuntime_CompleteFeedbackNotification", "consumes": [], "produces": [ @@ -1170,7 +1158,7 @@ { "name": "lockToken", "in": "path", - "description": "Lock token.", + "description": "The lock token obtained when the C2D message was received, and provided to resolve race conditions when completing a feedback message.", "required": true, "type": "string" }, @@ -1187,8 +1175,7 @@ }, "/messages/serviceBound/feedback/{lockToken}/abandon": { "post": { - "summary": "This method abandons a feedback message.", - "description": "This method abandons a feedback message. The lockToken obtained when the message was received must be provided to resolve race conditions when abandoning, a feedback message. A abandoned message is deleted from the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "This method abandons a cloud-to-device feedback message. An abandoned message is deleted from the service's feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging for more information.", "operationId": "HttpRuntime_AbandonFeedbackNotification", "consumes": [], "produces": [ @@ -1198,7 +1185,7 @@ { "name": "lockToken", "in": "path", - "description": "Lock Token.", + "description": "The lock token obtained when the C2D message was received, and provided to resolve race conditions when abandoning a feedback message.", "required": true, "type": "string" }, @@ -1215,8 +1202,7 @@ }, "/jobs/v2/{id}": { "get": { - "summary": "Retrieves details of a scheduled job from an IoT hub.", - "description": "Retrieves details of a scheduled job from an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Retrieves details of a scheduled job from IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.", "operationId": "JobClient_GetJob", "consumes": [], "produces": [ @@ -1226,7 +1212,7 @@ { "name": "id", "in": "path", - "description": "Job ID.", + "description": "The unique identifier of the job.", "required": true, "type": "string" }, @@ -1236,7 +1222,7 @@ ], "responses": { "200": { - "description": "Returns the Job response object", + "description": "Returns the job details.", "schema": { "$ref": "#/definitions/JobResponse" } @@ -1244,8 +1230,7 @@ } }, "put": { - "summary": "Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time.", - "description": "Creates a new job to schedule update twins or device direct methods on an IoT hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Creates a new job to schedule twin updates or direct methods on IoT Hub at a scheduled time. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.", "operationId": "JobClient_CreateJob", "consumes": [ "application/json" @@ -1257,13 +1242,14 @@ { "name": "id", "in": "path", - "description": "Job ID.", + "description": "The unique identifier of the job.", "required": true, "type": "string" }, { "name": "jobRequest", "in": "body", + "description": "The job to be created.", "required": true, "schema": { "$ref": "#/definitions/JobRequest" @@ -1275,7 +1261,7 @@ ], "responses": { "200": { - "description": "Returns the Job response object", + "description": "Returns the job response.", "schema": { "$ref": "#/definitions/JobResponse" } @@ -1285,8 +1271,7 @@ }, "/jobs/v2/{id}/cancel": { "post": { - "summary": "Cancels a scheduled job on an IoT hub.", - "description": "Cancels a scheduled job on an IoT hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Cancels a scheduled job on IoT Hub. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs for more information.", "operationId": "JobClient_CancelJob", "consumes": [], "produces": [ @@ -1296,7 +1281,7 @@ { "name": "id", "in": "path", - "description": "Job ID.", + "description": "The unique identifier of the job.", "required": true, "type": "string" }, @@ -1306,7 +1291,7 @@ ], "responses": { "200": { - "description": "Returns the Job response object", + "description": "Returns the job response", "schema": { "$ref": "#/definitions/JobResponse" } @@ -1316,8 +1301,7 @@ }, "/jobs/v2/query": { "get": { - "summary": "Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language", - "description": "Query an IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information. Pagination of results is supported. This returns information about jobs only. For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Query IoT hub to retrieve information regarding jobs using the IoT Hub query language. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language for more information.", "operationId": "JobClient_QueryJobs", "consumes": [], "produces": [ @@ -1327,14 +1311,14 @@ { "name": "jobType", "in": "query", - "description": "Job Type.", + "description": "The job type. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible job types.", "required": false, "type": "string" }, { "name": "jobStatus", "in": "query", - "description": "Job Status.", + "description": "The job status. See https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs#querying-for-progress-on-jobs for a list of possible statuses.", "required": false, "type": "string" }, @@ -1344,7 +1328,7 @@ ], "responses": { "200": { - "description": "Returns the Query Result object", + "description": "Returns the Query Result.", "schema": { "$ref": "#/definitions/QueryResult" } @@ -1354,8 +1338,7 @@ }, "/devices/{id}/modules": { "get": { - "summary": "Retrieve all the module identities on the device.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get all the module identities of the device.", "operationId": "RegistryManager_GetModulesOnDevice", "consumes": [], "produces": [ @@ -1365,7 +1348,7 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, @@ -1375,7 +1358,7 @@ ], "responses": { "200": { - "description": "Returns the Device object", + "description": "Returns all the modules of the device.", "schema": { "type": "array", "items": { @@ -1388,8 +1371,7 @@ }, "/devices/{id}/modules/{mid}": { "get": { - "summary": "Retrieve the specified module identity on the device.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Get the specified module identity of the device.", "operationId": "RegistryManager_GetModule", "consumes": [], "produces": [ @@ -1399,14 +1381,14 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "mid", "in": "path", - "description": "Module ID.", + "description": "The unique identifier of the module.", "required": true, "type": "string" }, @@ -1416,7 +1398,7 @@ ], "responses": { "200": { - "description": "Returns the DeviceModule object", + "description": "Returns the module.", "schema": { "$ref": "#/definitions/Module" } @@ -1424,8 +1406,7 @@ } }, "put": { - "summary": "Create or update the module identity for device in IoT hub. An ETag must not be specified for the create operation. An ETag must be specified for the update operation. Note that moduleId and generation cannot be updated by the user.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Create or update the module identity for device in IoT hub. The moduleId and generation cannot be updated by the user.", "operationId": "RegistryManager_CreateOrUpdateModule", "consumes": [ "application/json" @@ -1437,19 +1418,20 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "mid", "in": "path", - "description": "Module ID.", + "description": "The unique identifier of the module.", "required": true, "type": "string" }, { "name": "module", + "description": "The module identity.", "in": "body", "required": true, "schema": { @@ -1458,6 +1440,7 @@ }, { "name": "If-Match", + "description": "A string representing a weak ETag for the module, as per RFC7232. Should not be set when creating module, but may be set when updating a module", "in": "header", "required": false, "type": "string" @@ -1468,22 +1451,21 @@ ], "responses": { "200": { - "description": "Returns the updated DeviceModule object", + "description": "Returns the updated module.", "schema": { "$ref": "#/definitions/Module" } }, "201": { - "description": "Returns the created DeviceModule object", + "description": "Returns the created module.", "schema": { "$ref": "#/definitions/Module" } } } }, - "delete": { - "summary": "Delete the module identity for device of an IoT hub. This request requires the If-Match header. The client may specify the ETag for the device identity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation is performed only if the ETag sent by the client matches the value maintained by the server, indicating that the device identity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "delete": { + "description": "Delete the module identity for device of an IoT hub.", "operationId": "RegistryManager_DeleteModule", "consumes": [], "produces": [ @@ -1493,19 +1475,20 @@ { "name": "id", "in": "path", - "description": "Device ID.", + "description": "The unique identifier of the deivce.", "required": true, "type": "string" }, { "name": "mid", "in": "path", - "description": "Module ID.", + "description": "The unique identifier of the module.", "required": true, "type": "string" }, { "name": "If-Match", + "description": " A string representing a weak ETag for the module, as per RFC7232. The delete operation is performed only if this ETag matches the value maintained by the server, indicating that the module has not been modified since it was last retrieved. To force an unconditional delete, set If-Match to the wildcard character (*).", "in": "header", "required": false, "type": "string" @@ -1523,8 +1506,7 @@ }, "/digitalTwins/models/{modelId}": { "get": { - "summary": "Returns a DigitalTwin model definition for the given id.\r\nIf \"expand\" is present in the query parameters and id is for a device capability model then it returns\r\nthe capability metamodel with expanded interface definitions.", - "description": " For IoT Hub VNET related features(https://docs.microsoft.com/en-us/azure/iot-hub/virtual-network-support) please use API version '2020-03-13'.These features are currently in general availability in the East US, West US 2, and Southcentral US regions only. We are actively working to expand the availability of these features to all regions by end of month May. For rest of the APIs please continue using API version '2019-10-01'", + "description": "Returns a DigitalTwin model definition for the given id.\r\nIf \"expand\" is present in the query parameters and id is for a device capability model then it returns\r\nthe capability metamodel with expanded interface definitions.", "operationId": "DigitalTwin_GetDigitalTwinModel", "consumes": [], "produces": [ @@ -1600,7 +1582,6 @@ }, "/twins/{deviceId}/methods": { "post": { - "summary": "Invoke a direct method on a device.", "description": "Invoke a direct method on a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information.", "operationId": "DeviceMethod_InvokeDeviceMethod", "consumes": [ @@ -1613,12 +1594,14 @@ { "name": "deviceId", "in": "path", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "directMethodRequest", "in": "body", + "description": "Parameters to execute a direct method on the device.", "required": true, "schema": { "$ref": "#/definitions/CloudToDeviceMethod" @@ -1630,7 +1613,7 @@ ], "responses": { "200": { - "description": "Returns the method response payload", + "description": "The direct method response payload.", "schema": { "$ref": "#/definitions/CloudToDeviceMethodResult" } @@ -1640,8 +1623,7 @@ }, "/twins/{deviceId}/modules/{moduleId}/methods": { "post": { - "summary": "Invoke a direct method on a module of a device.", - "description": "Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information", + "description": "Invoke a direct method on a module of a device. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-direct-methods for more information.", "operationId": "DeviceMethod_InvokeModuleMethod", "consumes": [ "application/json" @@ -1653,18 +1635,21 @@ { "name": "deviceId", "in": "path", + "description": "The unique identifier of the device.", "required": true, "type": "string" }, { "name": "moduleId", "in": "path", + "description": "The unique identifier of the module.", "required": true, "type": "string" }, { "name": "directMethodRequest", "in": "body", + "description": "Parameters to execute a direct method on the module.", "required": true, "schema": { "$ref": "#/definitions/CloudToDeviceMethod" @@ -1676,7 +1661,7 @@ ], "responses": { "200": { - "description": "Returns the method response payload", + "description": "The direct method response payload.", "schema": { "$ref": "#/definitions/CloudToDeviceMethodResult" } @@ -1768,18 +1753,20 @@ }, "definitions": { "ConfigurationMetrics": { - "description": "Configuration Metrics", + "description": "Configuration Metrics for IotHub devices and modules.", "type": "object", "properties": { "results": { "type": "object", - "additionalProperties": { + "description": "TODO: Service to fill in", + "additionalProperties": { "format": "int64", "type": "integer" } }, "queries": { "type": "object", + "description": "TODO: Service to fill in", "additionalProperties": { "type": "string" } @@ -1791,15 +1778,15 @@ "type": "object", "properties": { "id": { - "description": "Gets Identifier for the configuration", + "description": "The unique identifier of the configuration.", "type": "string" }, "schemaVersion": { - "description": "Gets Schema version for the configuration", + "description": "Schema version of the configuration", "type": "string" }, "labels": { - "description": "Gets or sets labels for the configuration", + "description": "Key-value pairs used to describe a configuration", "type": "object", "additionalProperties": { "type": "string" @@ -1807,37 +1794,37 @@ }, "content": { "$ref": "#/definitions/ConfigurationContent", - "description": "Gets or sets Content for the configuration" + "description": "Content of the configuration." }, "targetCondition": { - "description": "Gets or sets Target Condition for the configuration", + "description": "The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties", "type": "string" }, "createdTimeUtc": { "format": "date-time", - "description": "Gets creation time for the configuration", + "description": "Creation time of the configuration.", "type": "string" }, "lastUpdatedTimeUtc": { "format": "date-time", - "description": "Gets last update time for the configuration", + "description": "Update time of the configuration.", "type": "string" }, "priority": { "format": "int32", - "description": "Gets or sets Priority for the configuration", + "description": "The priority number assigned to the configuration.", "type": "integer" }, "systemMetrics": { "$ref": "#/definitions/ConfigurationMetrics", - "description": "System Configuration Metrics" + "description": "Metrics calculated by IoT Hub that cannot be customized." }, "metrics": { "$ref": "#/definitions/ConfigurationMetrics", - "description": "Custom Configuration Metrics" + "description": "Custom metrics specified by developer as queries against twin reported properties" }, "etag": { - "description": "Gets or sets configuration's ETag", + "description": "ETag of the configuration", "type": "string" } } @@ -1847,14 +1834,14 @@ "type": "object", "properties": { "deviceContent": { - "description": "Gets or sets device Configurations", + "description": "Device Configurations", "type": "object", "additionalProperties": { "type": "object" } }, "modulesContent": { - "description": "Gets or sets Modules Configurations", + "description": "Modules configuration content", "type": "object", "additionalProperties": { "type": "object", @@ -1864,7 +1851,7 @@ } }, "moduleContent": { - "description": "Gets or sets Module Configurations", + "description": "Module configuration content", "type": "object", "additionalProperties": { "type": "object" @@ -1876,10 +1863,12 @@ "type": "object", "properties": { "targetCondition": { - "type": "string" + "type": "string", + "description": "The query used to define targeted devices or modules. The query is based on twin tags and/or reported properties" }, "customMetricQueries": { - "type": "object", + "type": "string", + "description": "Queries on twin reported properties", "additionalProperties": { "type": "string" } @@ -1890,12 +1879,14 @@ "type": "object", "properties": { "targetConditionError": { - "type": "string" + "type": "string", + "description": "Errors running the target condition query." }, "customMetricQueryErrors": { "type": "object", "additionalProperties": { - "type": "string" + "type": "string", + "description": "Errors running the custom metric query." } } } @@ -1905,15 +1896,18 @@ "properties": { "totalDeviceCount": { "format": "int64", - "type": "integer" + "type": "integer", + "description": "The total number of devices registered for this hub." }, "enabledDeviceCount": { "format": "int64", - "type": "integer" + "type": "integer", + "description": "The number of currently enabled devices." }, "disabledDeviceCount": { "format": "int64", - "type": "integer" + "type": "integer", + "description": "The number of currently disabled devices." } } }, @@ -1922,7 +1916,8 @@ "properties": { "connectedDeviceCount": { "format": "int64", - "type": "integer" + "type": "integer", + "description": "The number of currently connected devices." } } }, @@ -1930,58 +1925,72 @@ "type": "object", "properties": { "deviceId": { - "type": "string" + "type": "string", + "description": "The unique identifier of this device." }, "generationId": { - "type": "string" + "type": "string", + "description": "An IoT hub-generated, case-sensitive string up to 128 characters long. This value is used to distinguish devices with the same deviceId, when they have been deleted and re-created." }, "etag": { - "type": "string" + "type": "string", + "description": "A string representing a weak ETag for the device identity, as per RFC7232." }, "connectionState": { "enum": [ "Disconnected", "Connected" ], - "type": "string" + "type": "string", + "description": "Tells whether the device is connected or not." }, "status": { "enum": [ "enabled", "disabled" ], - "type": "string" + "type": "string", + "description": "Flags whether a device is enabled or not. If disabled, a device cannot connect to the service." }, "statusReason": { - "type": "string" + "type": "string", + "description": "A 128 character-long string that stores the reason for the device identity status. All UTF-8 characters are allowed." }, "connectionStateUpdatedTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "A temporal indicator, showing the date and last time the connection state was updated." }, "statusUpdatedTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "The last timestamp of when the status field was updated." }, "lastActivityTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "A temporal indicator, showing the date and last time the device connected, received, or sent a message." }, "cloudToDeviceMessageCount": { "format": "int32", - "type": "integer" + "type": "integer", + "description": "The number of cloud to device messages currently queued to be sent to the device." }, "authentication": { - "$ref": "#/definitions/AuthenticationMechanism" + "$ref": "#/definitions/AuthenticationMechanism", + "description": "The details on what authentication mechanisms are used by this device." }, "capabilities": { - "$ref": "#/definitions/DeviceCapabilities" + "$ref": "#/definitions/DeviceCapabilities", + "description": "The set of capabilities that this device has. For example, if this device is an edge device or not." }, "deviceScope": { - "type": "string" + "type": "string", + "description": "The scope that this device belongs to." }, "parentScopes": { "type": "array", + "description": "TODO: service team needs to explain this", "items": { "type": "string" } @@ -1992,10 +2001,12 @@ "type": "object", "properties": { "symmetricKey": { - "$ref": "#/definitions/SymmetricKey" + "$ref": "#/definitions/SymmetricKey", + "description": "The primary and secondary keys used for SAS based authentication." }, "x509Thumbprint": { - "$ref": "#/definitions/X509Thumbprint" + "$ref": "#/definitions/X509Thumbprint", + "description": "The primary and secondary x509 thumbprints used for x509 based authentication." }, "type": { "enum": [ @@ -2004,7 +2015,8 @@ "certificateAuthority", "none" ], - "type": "string" + "type": "string", + "description": "The type of authentication used when connecting to the service." } } }, @@ -2013,6 +2025,7 @@ "type": "object", "properties": { "iotEdge": { + "description": "Whether or not this device is an edge device.", "type": "boolean" } } @@ -2021,10 +2034,12 @@ "type": "object", "properties": { "primaryKey": { - "type": "string" + "type": "string", + "description": "The base 64 encoded primary key of your device." }, "secondaryKey": { - "type": "string" + "type": "string", + "description": "The base 64 encoded secondary key of your device." } } }, @@ -2032,9 +2047,11 @@ "type": "object", "properties": { "primaryThumbprint": { + "description": "Gets and sets the X509 client certificate primary thumbprint.", "type": "string" }, "secondaryThumbprint": { + "description": "Gets and sets the X509 client certificate secondary thumbprint.", "type": "string" } } @@ -2043,11 +2060,11 @@ "type": "object", "properties": { "id": { - "description": "Device Id is always required", + "description": "Identifier of the device to perform this operation on.", "type": "string" }, "moduleId": { - "description": "ModuleId is applicable to modules only", + "description": "Identifier of the module to perform this operation on, if applicable.", "type": "string" }, "eTag": { @@ -2064,10 +2081,11 @@ "updateTwin", "updateTwinIfMatchETag" ], - "type": "string" + "type": "string", + "description": "The type of registry operation and if ETag should be ignored or not." }, "status": { - "description": "Status is optional and defaults to enabled", + "description": "Flags whether a module is enabled or not. If disabled, a module cannot connect to the service.", "enum": [ "enabled", "disabled" @@ -2075,37 +2093,42 @@ "type": "string" }, "statusReason": { - "type": "string" + "type": "string", + "description": "A 128 character-long string that stores the reason for the device identity status. All UTF-8 characters are allowed." }, "authentication": { "$ref": "#/definitions/AuthenticationMechanism", - "description": "Authentication parameter is optional and defaults to SAS if not provided. In that case, we auto-generate primary/secondary access keys" + "description": "Authentication parameter is optional and defaults to SAS if not provided. In that case, we auto-generate primary/secondary access keys." }, "twinETag": { - "description": "twinETag parameter is only used for pre-conditioning the update when importMode is updateTwinIfMatchETag", + "description": "twinETag parameter is only used for pre-conditioning the update when importMode is updateTwinIfMatchETag.", "type": "string" }, "tags": { "type": "object", "additionalProperties": { - "type": "object" + "type": "object", + "description": "A JSON document read and written by the solution back end. Tags are not visible to device apps." } }, "properties": { "$ref": "#/definitions/PropertyContainer", - "description": "Properties are optional and defaults to empty object" + "description": "TODO need service folks to explain this." }, "capabilities": { "$ref": "#/definitions/DeviceCapabilities", - "description": "Capabilities param is optional and defaults to no capability" + "description": "Status of capabilities enabled on the device." }, "deviceScope": { - "type": "string" + "type": "string", + "description": "The scope that this identity belongs to." }, "parentScopes": { "type": "array", + "description": "TODO: service team needs to explain this", "items": { - "type": "string" + "type": "string", + "description": "TODO service folks need to explain this." } } } @@ -2159,7 +2182,7 @@ "type": "object", "properties": { "deviceId": { - "description": "The ID of the device that indicated the error.", + "description": "Identifier of the device that indicated the error.", "type": "string" }, "errorCode": { @@ -2388,10 +2411,12 @@ "type": "string" }, "moduleId": { - "type": "string" + "type": "string", + "description": "Identifier of the module associated with the error, if applicable." }, "operation": { - "type": "string" + "type": "string", + "description": "The type of the operation that failed." } } }, @@ -2400,14 +2425,15 @@ "type": "object", "properties": { "deviceId": { - "description": "The ID of the device that indicated the warning.", + "description": "Identifier of the device that indicated the warning.", "type": "string" }, "warningCode": { "enum": [ "DeviceRegisteredWithoutTwin" ], - "type": "string" + "type": "string", + "description": "The code associated with the warning." }, "warningStatus": { "description": "Additional details associated with the warning.", @@ -2426,30 +2452,31 @@ } }, "Twin": { - "description": "Twin Representation", + "description": "The state information for a device or module. Implicitly created and deleted when the corresponding device/ module identity is created or deleted in IoT Hub.", "type": "object", "properties": { "deviceId": { - "description": "The deviceId uniquely identifies the device in the IoT hub's identity registry. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.", + "description": "The unique identifier of the device in the IoT hub's identity registry. It is a case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars, and the following special characters {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.", "type": "string" }, "moduleId": { - "description": "Gets and sets the Module Id.", + "description": "The unique identifier of the module in the IoT hub's identity registry. It is a case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars, and the following special characters {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.", "type": "string" }, "tags": { - "description": "A JSON document read and written by the solution back end. Tags are not visible to device apps.", + "description": "A collection of key-value pairs read and written by the solution back end. They are not visible to device apps.", "type": "object", "additionalProperties": { + "description": "The collection of the twin's tags as key-value pairs. They keys are UTF-8 encoded, case-sensitive and up-to 1KB in length. Allowed characters exclude UNICODE control characters (segments C0 and C1), '.', '$' and space. The values are JSON objects, up-to 4KB in length.", "type": "object" } }, "properties": { "$ref": "#/definitions/TwinProperties", - "description": "Gets and sets the Twin properties." + "description": "The twin's desired and reported properties." }, "etag": { - "description": "Twin's ETag", + "description": "TODO - which operation does this affect - update tags/ properties etc?", "type": "string" }, "version": { @@ -2458,11 +2485,11 @@ "type": "integer" }, "deviceEtag": { - "description": "Device's ETag", + "description": "TODO - which operation does this affect?", "type": "string" }, "status": { - "description": "Gets the corresponding Device's Status.", + "description": "Flags whether a device is enabled or not. If disabled, a device cannot connect to the service.", "enum": [ "enabled", "disabled" @@ -2470,16 +2497,16 @@ "type": "string" }, "statusReason": { - "description": "Reason, if any, for the corresponding Device to be in specified Status", + "description": "Reason, if any, for the device's current status.", "type": "string" }, "statusUpdateTime": { "format": "date-time", - "description": "Time when the corresponding Device's Status was last updated", + "description": "Time when the corresponding device's status was last updated.", "type": "string" }, "connectionState": { - "description": "Corresponding Device's ConnectionState", + "description": "The device's connection state.", "enum": [ "Disconnected", "Connected" @@ -2514,9 +2541,11 @@ "$ref": "#/definitions/DeviceCapabilities" }, "deviceScope": { + "description": "Scope to which this device instance belongs to", "type": "string" }, "parentScopes": { + "description": "TODO: new property added - need explanation", "type": "array", "items": { "type": "string" @@ -2525,20 +2554,22 @@ } }, "TwinProperties": { - "description": "Represents Twin properties", + "description": "The twin's desired and reported properties. The maximum depth of twin property objects is 10.", "type": "object", "properties": { "desired": { - "description": "Used in conjunction with reported properties to synchronize device configuration or condition. Desired properties can only be set by the solution back end and can be read by the device app. The device app can also be notified in real time of changes on the desired properties.", + "description": "Properties that are set by the solution back end and read by the device.", "type": "object", "additionalProperties": { + "description": "The collection of desired property key-value pairs. The keys are UTF-8 encoded, case-sensitive and up-to 1KB in length. Allowed characters exclude UNICODE control characters (segments C0 and C1), '.', '$' and space. The desired porperty values are JSON objects, up-to 4KB in length.", "type": "object" } }, "reported": { - "description": "Used in conjunction with desired properties to synchronize device configuration or condition. Reported properties can only be set by the device app and can be read and queried by the solution back end.", + "description": "Properties that are set by the device, and read and queried by the solution back end.", "type": "object", "additionalProperties": { + "description": "The collection of reported property key-value pairs. The keys are UTF-8 encoded, case-sensitive and up-to 1KB in length. Allowed characters exclude UNICODE control characters (segments C0 and C1), '.', '$' and space. The reported property values are JSON objects, up-to 4KB in length.", "type": "object" } } @@ -2548,21 +2579,21 @@ "type": "object", "properties": { "jobId": { - "description": "System generated. Ignored at creation.", + "description": "The unique identifier of the job.", "type": "string" }, "startTimeUtc": { "format": "date-time", - "description": "System generated. Ignored at creation.", + "description": "The start time of the job in UTC.", "type": "string" }, "endTimeUtc": { "format": "date-time", - "description": "System generated. Ignored at creation.\r\nRepresents the time the job stopped processing.", + "description": "The time the job stopped.", "type": "string" }, "type": { - "description": "Required.\r\nThe type of job to execute.", + "description": "The type of job to execute.", "enum": [ "unknown", "export", @@ -2582,7 +2613,7 @@ "type": "string" }, "status": { - "description": "System generated. Ignored at creation.", + "description": "The status of the job.", "enum": [ "unknown", "enqueued", @@ -2597,7 +2628,7 @@ }, "progress": { "format": "int32", - "description": "System generated. Ignored at creation.\r\nRepresents the percentage of completion.", + "description": "Represents the percentage of completion.", "type": "integer" }, "inputBlobContainerUri": { @@ -2609,15 +2640,15 @@ "type": "string" }, "outputBlobContainerUri": { - "description": "URI containing SAS token to a blob container. This is used to output the status of the job and the results.", + "description": "SAS token to access a blob container. This is used to output the status of the job and the results.", "type": "string" }, "outputBlobName": { - "description": "The name of the blob that will be created in the provided output blob container. This blob will contain\r\nthe exported device registry information for the IoT Hub.", + "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.", "type": "string" }, "excludeKeysInExport": { - "description": "Optional for export jobs; ignored for other jobs. Default: false. If false, authorization keys are included\r\nin export output. Keys are exported as null otherwise.", + "description": "Optional for export jobs; ignored for other jobs. If not specified, the service defaults to false. If false, authorization keys are included in export output. Keys are exported as null otherwise.", "type": "boolean" }, "storageAuthenticationType": { @@ -2629,7 +2660,7 @@ "type": "string" }, "failureReason": { - "description": "System genereated. Ignored at creation.\r\nIf status == failure, this represents a string containing the reason.", + "description": "Contains the reason for the failure, if a failure occurred.", "type": "string" } } @@ -2639,6 +2670,7 @@ "type": "object", "properties": { "totalMessagesPurged": { + "description": "The total number of messages purged.", "format": "int32", "type": "integer" }, @@ -2656,9 +2688,11 @@ "type": "object", "properties": { "IotHubName": { - "type": "string" + "type": "string", + "description": "Name of the IotHub." }, "connection": { + "description": "TODO: to be filled by the service team.", "$ref": "#/definitions/FaultInjectionConnectionProperties" }, "lastUpdatedTimeUtc": { @@ -2672,6 +2706,7 @@ "type": "object", "properties": { "action": { + "description": "Action to perform", "enum": [ "None", "CloseAll", @@ -2680,6 +2715,7 @@ "type": "string" }, "blockDurationInMinutes": { + "description": "TODO: to be filled by the service team", "format": "int32", "type": "integer" } @@ -2777,7 +2813,7 @@ "type": "string" }, "type": { - "description": "Required.\r\nThe type of job to execute.", + "description": "The type of job to execute.", "enum": [ "unknown", "export", @@ -2798,13 +2834,13 @@ }, "cloudToDeviceMethod": { "$ref": "#/definitions/CloudToDeviceMethod", - "description": "Required if jobType is cloudToDeviceMethod.\r\nThe method type and parameters." + "description": "Required if jobType is cloudToDeviceMethod. The method type and parameters." }, "updateTwin": { "$ref": "#/definitions/Twin" }, "queryCondition": { - "description": "Required if jobType is updateTwin or cloudToDeviceMethod.\r\nCondition for device query to get devices to execute the job on", + "description": "Required if jobType is updateTwin or cloudToDeviceMethod. Condition for device query to get devices to execute the job on.", "type": "string" }, "startTime": { @@ -2820,22 +2856,24 @@ } }, "CloudToDeviceMethod": { - "description": "Parameters to execute a direct method on the device", + "description": "Parameters to execute a direct method on the device.", "type": "object", "properties": { "methodName": { - "description": "Method to run", + "description": "Name of the method to be executed.", "type": "string" }, "payload": { - "description": "Payload", + "description": "The JSON-formatted direct method payload, up to 128kb in size.", "type": "object" }, "responseTimeoutInSeconds": { + "description": "Time (in seconds) that the service waits for the method invocation to return a response. It defaults to 30 seconds. Minimum allowed value is 5 seconds, maximum allowed value is 300 seconds.", "format": "int32", "type": "integer" }, "connectTimeoutInSeconds": { + "description": "Time (in seconds) that the service waits for the device to come online. It defaults to 0, meaning the device must already be online. Maximum allowed value is 300 seconds.", "format": "int32", "type": "integer" } @@ -2845,7 +2883,7 @@ "type": "object", "properties": { "jobId": { - "description": "System generated. Ignored at creation.", + "description": "The unique identifier of the job.", "type": "string" }, "queryCondition": { @@ -2854,7 +2892,7 @@ }, "createdTime": { "format": "date-time", - "description": "System generated. Ignored at creation.", + "description": "The creation time of the job.", "type": "string" }, "startTime": { @@ -2864,7 +2902,7 @@ }, "endTime": { "format": "date-time", - "description": "System generated. Ignored at creation.\r\nRepresents the time the job stopped processing.", + "description": "The time the job stopped.", "type": "string" }, "maxExecutionTimeInSeconds": { @@ -2873,7 +2911,7 @@ "type": "integer" }, "type": { - "description": "Required.\r\nThe type of job to execute.", + "description": "The type of job to execute.", "enum": [ "unknown", "export", @@ -2894,13 +2932,13 @@ }, "cloudToDeviceMethod": { "$ref": "#/definitions/CloudToDeviceMethod", - "description": "Required if jobType is cloudToDeviceMethod.\r\nThe method type and parameters." + "description": "Required if jobType is cloudToDeviceMethod. The method type and parameters." }, "updateTwin": { "$ref": "#/definitions/Twin" }, "status": { - "description": "System generated. Ignored at creation.", + "description": "The status of the job.", "enum": [ "unknown", "enqueued", @@ -2914,7 +2952,7 @@ "type": "string" }, "failureReason": { - "description": "System generated. Ignored at creation.\r\nIf status == failure, this represents a string containing the reason.", + "description": "Contains the reason for the failure, if a failure occurred.", "type": "string" }, "statusMessage": { @@ -2990,25 +3028,31 @@ } }, "Module": { - "description": "Module identity on a device", + "description": "Module identity on a device.", "type": "object", "properties": { "moduleId": { - "type": "string" + "type": "string", + "description": "The unique identifier of this module." }, "managedBy": { - "type": "string" + "type": "string", + "description": "Identifies who manages this module. For instance, this value is \"IotEdge\" if the edge runtime owns this module." }, "deviceId": { - "type": "string" + "type": "string", + "description": "The unique identifier of the device that has this module." }, "generationId": { - "type": "string" + "type": "string", + "description": "An IoT hub-generated, case-sensitive string up to 128 characters long. This value is used to distinguish modules with the same moduleId, when they have been deleted and re-created." }, "etag": { - "type": "string" + "type": "string", + "description": "A string representing a weak ETag for the module identity, as per RFC7232." }, "connectionState": { + "description": "Tells whether the module is connected or not.", "enum": [ "Disconnected", "Connected" @@ -3017,18 +3061,22 @@ }, "connectionStateUpdatedTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "A temporal indicator, showing the date and last time the connection state was updated." }, "lastActivityTime": { "format": "date-time", - "type": "string" + "type": "string", + "description": "A temporal indicator, showing the date and last time the device connected, received, or sent a message." }, "cloudToDeviceMessageCount": { "format": "int32", - "type": "integer" + "type": "integer", + "description": "The number of cloud to module messages currently queued to be sent to the module." }, "authentication": { - "$ref": "#/definitions/AuthenticationMechanism" + "$ref": "#/definitions/AuthenticationMechanism", + "description": "The details on what authentication mechanisms are used by this module when connecting to the service and edgehub." } } }, @@ -3038,11 +3086,11 @@ "properties": { "status": { "format": "int32", - "description": "Method invocation result status.", + "description": "Method invocation result status, provided by the device.", "type": "integer" }, "payload": { - "description": "Method invocation result payload.", + "description": "The JSON-formatted direct method result payload, up to 128kb in size; provided by the device.", "type": "object" } } @@ -3064,8 +3112,9 @@ "properties": { "desired": { "type": "object", + "description": "The desired property of the interface", "properties": { - "value": { + "value": { "description": "The desired value of the interface property to set in a digitalTwin.", "type": "object" } @@ -3090,4 +3139,4 @@ "default": "2020-03-13" } } -} \ No newline at end of file +}