Microsoft.IoTCentral (stable:2018-09-01)

2025/10/23 • 10 new, 10 deleted methods

Apps_Get (new)
Description :  Get the metadata of an IoT Central application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_CreateOrUpdate (new)
Description :  Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
App:
{
Description: The IoT Central application metadata and security metadata. ,
Required: True ,
}
{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_Update (new)
Description :  Update the metadata of an IoT Central application.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
AppPatch:
{
Description: The IoT Central application metadata and security metadata. ,
Required: True ,
}
{
tags:
{
Description: Instance tags ,
Required: False ,
}
object ,
sku:
{
Description: A valid instance SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_Delete (new)
Description :  Delete an IoT Central application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_ListBySubscription (new)
Description :  Get all IoT Central Applications in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central Applications. ,
Required: False ,
}
string ,
value:
{
Description: A list of IoT Central Applications. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_ListByResourceGroup (new)
Description :  Get all the IoT Central Applications in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps
{
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 IoT Central application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central Applications. ,
Required: False ,
}
string ,
value:
{
Description: A list of IoT Central Applications. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_CheckNameAvailability (new)
Description :  Check if an IoT Central application name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
operationInputs:
{
Description: Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check. ,
Required: True ,
}
{
name:
{
Description: The name of the IoT Central application instance to check. ,
Required: True ,
}
string ,
type:
{
Description: The type of the IoT Central resource to query. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_CheckSubdomainAvailability (new)
Description :  Check if an IoT Central application subdomain is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
operationInputs:
{
Description: Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check. ,
Required: True ,
}
{
name:
{
Description: The name of the IoT Central application instance to check. ,
Required: True ,
}
string ,
type:
{
Description: The type of the IoT Central resource to query. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_ListTemplates (new)
Description :  Get all available application templates.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/appTemplates
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central application templates. ,
Required: False ,
}
string ,
value:
{
Description: A list of IoT Central Application Templates. ,
Required: False ,
}
[
{
manifestId:
{
Description: The ID of the template. ,
Required: False ,
}
string ,
manifestVersion:
{
Description: The version of the template. ,
Required: False ,
}
string ,
name:
{
Description: The name of the template. ,
Required: False ,
}
string ,
title:
{
Description: The title of the template. ,
Required: False ,
}
string ,
order:
{
Description: The order of the template in the templates list. ,
Required: False ,
}
number ,
description:
{
Description: The description of the template. ,
Required: False ,
}
string ,
industry:
{
Description: The industry of the template. ,
Required: False ,
}
string ,
locations:
{
Description: A list of locations that support the template. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the location. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the location. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available IoT Central application REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of operations supported by the Microsoft.IoTCentral resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft IoT Central ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: IoT Central ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Friendly description for the operation, ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_Get (removed)
Description :  Get the metadata of an IoT Central application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_CreateOrUpdate (removed)
Description :  Create or update the metadata of an IoT Central application. The usual pattern to modify a property is to retrieve the IoT Central application metadata and security metadata, and then combine them with the modified values in a new body to update the IoT Central application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
App:
{
Description: The IoT Central application metadata and security metadata. ,
Required: True ,
}
{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_Update (removed)
Description :  Update the metadata of an IoT Central application.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
AppPatch:
{
Description: The IoT Central application metadata and security metadata. ,
Required: True ,
}
{
tags:
{
Description: Instance tags ,
Required: False ,
}
object ,
sku:
{
Description: A valid instance SKU. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_Delete (removed)
Description :  Delete an IoT Central application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}
{
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 IoT Central application. ,
Required: True ,
}
string ,
resourceName:
{
Description: The ARM resource name of the IoT Central application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_ListBySubscription (removed)
Description :  Get all IoT Central Applications in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central Applications. ,
Required: False ,
}
string ,
value:
{
Description: A list of IoT Central Applications. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_ListByResourceGroup (removed)
Description :  Get all the IoT Central Applications in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps
{
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 IoT Central application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central Applications. ,
Required: False ,
}
string ,
value:
{
Description: A list of IoT Central Applications. ,
Required: False ,
}
[
{
properties:
{
Description: The common properties of an IoT Central application. ,
Required: False ,
}
{
applicationId:
{
Description: The ID of the application. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
subdomain:
{
Description: The subdomain of the application. ,
Required: False ,
}
string ,
template:
{
Description: The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch. ,
Required: False ,
}
string ,
state:
{
Description: The current state of the application. ,
Enum:
{
created: No description available. ,
suspended: No description available. ,
}
,
Required: False ,
}
enum ,
geography:
{
Description: The geography the application is in. ,
Required: False ,
}
string ,
thumbnailUrl:
{
Description: The URI for the thumbnail image used in the application. ,
Required: False ,
}
string ,
tenant:
{
Description: The tenant ID the application belongs to. ,
Required: False ,
}
string ,
}
,
sku:
{
Description: A valid instance SKU. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Enum:
{
F1: No description available. ,
S1: No description available. ,
ST0: No description available. ,
ST1: No description available. ,
ST2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_CheckNameAvailability (removed)
Description :  Check if an IoT Central application name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
operationInputs:
{
Description: Set the name parameter in the OperationInputs structure to the name of the IoT Central application to check. ,
Required: True ,
}
{
name:
{
Description: The name of the IoT Central application instance to check. ,
Required: True ,
}
string ,
type:
{
Description: The type of the IoT Central resource to query. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_CheckSubdomainAvailability (removed)
Description :  Check if an IoT Central application subdomain is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
operationInputs:
{
Description: Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application to check. ,
Required: True ,
}
{
name:
{
Description: The name of the IoT Central application instance to check. ,
Required: True ,
}
string ,
type:
{
Description: The type of the IoT Central resource to query. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Apps_ListTemplates (removed)
Description :  Get all available application templates.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/appTemplates
{
api-version:
{
Description: The version of the API. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central application templates. ,
Required: False ,
}
string ,
value:
{
Description: A list of IoT Central Application Templates. ,
Required: False ,
}
[
{
manifestId:
{
Description: The ID of the template. ,
Required: False ,
}
string ,
manifestVersion:
{
Description: The version of the template. ,
Required: False ,
}
string ,
name:
{
Description: The name of the template. ,
Required: False ,
}
string ,
title:
{
Description: The title of the template. ,
Required: False ,
}
string ,
order:
{
Description: The order of the template in the templates list. ,
Required: False ,
}
number ,
description:
{
Description: The description of the template. ,
Required: False ,
}
string ,
industry:
{
Description: The industry of the template. ,
Required: False ,
}
string ,
locations:
{
Description: A list of locations that support the template. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the location. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the location. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available IoT Central application REST API operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of IoT Central description objects. ,
Required: False ,
}
string ,
value:
{
Description: A list of operations supported by the Microsoft.IoTCentral resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{read | write | action | delete} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft IoT Central ,
Required: False ,
}
string ,
resource:
{
Description: Resource Type: IoT Central ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation ,
Required: False ,
}
string ,
description:
{
Description: Friendly description for the operation, ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Additional descriptions for the operation. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error response body. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}