Microsoft.WindowsIoT (stable:2019-06-01)

2025/09/19 • 8 new, 8 deleted methods

Operations_List (new)
Description :  Lists all of the available Windows IoT Services REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.WindowsIoT/operations
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Windows IoT Device Service operations supported by the Microsoft.WindowsIoT resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Azure Data Catalog Service. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Azure Data Catalog Service. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
origin:
{
Description: Indicates the executor of the operation. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_Get (new)
Description :  Get the non-security related metadata of a Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_CreateOrUpdate (new)
Description :  Create or update the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceService:
{
Description: The Windows IoT Device Service metadata and security metadata. ,
Required: True ,
}
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Windows IoT Device Service. Do not specify for creating a new Windows IoT Device Service. Required to update an existing Windows IoT Device Service. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_Update (new)
Description :  Updates the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceService:
{
Description: The Windows IoT Device Service metadata and security metadata. ,
Required: True ,
}
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Windows IoT Device Service. Do not specify for creating a brand new Windows IoT Device Service. Required to update an existing Windows IoT Device Service. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_Delete (new)
Description :  Delete a Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_ListByResourceGroup (new)
Description :  Get all the IoT hubs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of DeviceService objects. ,
Required: False ,
}
[
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_List (new)
Description :  Get all the IoT hubs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/deviceServices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of DeviceService objects. ,
Required: False ,
}
[
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_CheckDeviceServiceNameAvailability (new)
Description :  Check if a Windows IoT Device Service name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/checkDeviceServiceNameAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
deviceServiceCheckNameAvailabilityParameters:
{
Description: Set the name parameter in the DeviceServiceCheckNameAvailabilityParameters structure to the name of the Windows IoT Device Service to check. ,
Required: True ,
}
{
name:
{
Description: The name of the Windows IoT Device Service to check. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value which indicates whether the provided name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed reason message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Windows IoT Services REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.WindowsIoT/operations
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Windows IoT Device Service operations supported by the Microsoft.WindowsIoT resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The operation supported by Azure Data Catalog Service. ,
Required: False ,
}
{
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
operation:
{
Description: The action that users can perform, based on their permission level. ,
Required: False ,
}
string ,
provider:
{
Description: Service provider: Azure Data Catalog Service. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
origin:
{
Description: Indicates the executor of the operation. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_Get (removed)
Description :  Get the non-security related metadata of a Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_CreateOrUpdate (removed)
Description :  Create or update the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceService:
{
Description: The Windows IoT Device Service metadata and security metadata. ,
Required: True ,
}
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Windows IoT Device Service. Do not specify for creating a new Windows IoT Device Service. Required to update an existing Windows IoT Device Service. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_Update (removed)
Description :  Updates the metadata of a Windows IoT Device Service. The usual pattern to modify a property is to retrieve the Windows IoT Device Service metadata and security metadata, and then combine them with the modified values in a new body to update the Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceService:
{
Description: The Windows IoT Device Service metadata and security metadata. ,
Required: True ,
}
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Windows IoT Device Service. Do not specify for creating a brand new Windows IoT Device Service. Required to update an existing Windows IoT Device Service. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_Delete (removed)
Description :  Delete a Windows IoT Device Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices/{deviceName}
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the Windows IoT Device Service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_ListByResourceGroup (removed)
Description :  Get all the IoT hubs in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.WindowsIoT/deviceServices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group that contains the Windows IoT Device Service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of DeviceService objects. ,
Required: False ,
}
[
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_List (removed)
Description :  Get all the IoT hubs in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/deviceServices
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The array of DeviceService objects. ,
Required: False ,
}
[
{
etag:
{
Description: The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Windows IoT Device Service. ,
Required: False ,
}
{
notes:
{
Description: Windows IoT Device Service notes. ,
Required: False ,
}
string ,
startDate:
{
Description: Windows IoT Device Service start date, ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: Windows IoT Device Service device allocation, ,
Format: int64 ,
Required: False ,
}
integer ,
billingDomainName:
{
Description: Windows IoT Device Service ODM AAD domain ,
Required: False ,
}
string ,
adminDomainName:
{
Description: Windows IoT Device Service OEM AAD domain ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}
Services_CheckDeviceServiceNameAvailability (removed)
Description :  Check if a Windows IoT Device Service name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.WindowsIoT/checkDeviceServiceNameAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
deviceServiceCheckNameAvailabilityParameters:
{
Description: Set the name parameter in the DeviceServiceCheckNameAvailabilityParameters structure to the name of the Windows IoT Device Service to check. ,
Required: True ,
}
{
name:
{
Description: The name of the Windows IoT Device Service to check. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: The value which indicates whether the provided name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason for unavailability. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The detailed reason message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}