POST /targets/targets/actions/newaicDeploy a new Azure IoT Central application based on the Verizon ARM template within the specified Azure Active Directory account. The attached guide walks through the Azure-side prerequisites to use this API. The instructions may vary as Microsoft Azure may change the flow as the platform evolves.
NOTE: After this API is used to create a new Azure IoT Central application, follow the steps here to onboard the devices to this new application.
See also:
Create a subscription
Create a target
POST https://thingspace.verizon.com/api/cc/v1/targets/actions/newaicNone.
The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token and must set the content-type to JSON.
| Property Name | Data Type | Description |
|---|---|---|
| Authorization required |
string | HTTP Authorization request header containing a valid ThingSpace Bearer token. |
| VZ-M2M-Token required |
string | A valid session token returned by a Connectivity Management API POST /session/login request using the account’s UWS credentials. |
| Content-Type required |
string | Must be application/json. |
| BillingaccountID required |
string | The ThingSpace ID of the authenticating billing account, in the format 0000123456-00001 |
The request body must include the UUID of the subscription that you want to update plus any properties that you want to change.
| Property Name | Data Type | Description |
|---|---|---|
| appName required |
string | A user defined name for the application being deployed in Azure IoT Central. This needs to be all lower case and less than 10 characters. "appName": "newarmapp1" |
| billingAccountID required |
string | The ThingSpace ID of the authenticating billing account, in the format "billingaccountID":"0000123456-00001" |
| clientID required |
string | The Azure ClientID of the associated Azure target account "clientID": "{UUID value}" |
| clientSecret required |
string | The Azure Client Secret of the associated Azure target account "clientSecret": "{client secret}" |
| emailIDs required |
string | The “email IDs” to be added to/sent to with this API. This should be the user’s email IDs who is creating the Azure IOT Central (AIC) App, and other users email IDs additionally, if any can also be added, if they are going to use this App. Please make sure that these email IDs have the Azure Subscription services “ON”, and be role-assigned as “contributor” using the IAM procedures. "emailIDs":"email@domain.com" |
| resourcegroup required |
string | The Azure Resource group of the associated Azure target account "resourcegroup": "Myresourcegroup" |
| sampleIOTcApp required |
string | This is the reference Azure IoT Central application developed by Verizon. "sampleIOTcApp": "{reference value}" |
| subscriptionID required |
string | The Azure Subscription ID of the associated Azure target account "subscriptionID": "{subscription ID}" |
| tenantID required |
string | The Azure Tenant ID of the associated Azure target account "tenantID": "{tenant ID}" |
Create a new target Azure IoT Central application:
curl --location --request POST 'https://thingspace.verizon.com/api/cc/v1/targets/actions/newaic' \
-H 'Authorization: Bearer {bearer token}' \
-H 'VZ-M2M-Token: {session token}' \
--header 'Billingaccountid: 0000123456-00001' \
--header 'Content-Type: application/json' \
--data-raw '{
"appName": "newarmapp1",
"billingAccountID": "0000123456-00001",
"clientID": "{UUID value}”,
"clientSecret": "clientSecret": "{client secret}"",
"emailIDs":"email@domain.com", ",
"resourcegroup": "Myresourcegroup",
"sampleIOTcApp": "{app ID}",
"subscriptionID": "{subscription ID}",
"tenantID": "{tenant ID}"
Status 200
A success response includes the full subscription resource definition.
Example Success Response
{
"appName":"newarmapp1",
"sharedSecret":"SharedAccessSignaturesr={client secret}"
"url":"https://newarmapp1.azureiotcentral.com"
}
| Property Name | Data Type | Description |
|---|---|---|
| appName |
string | An application will be created under the user's Azure subscription with this name and of type IOT central |
| sharedSecret |
string | Part of the user credentials (from Azure) the user needs to use for calling further TS Core APIs for setting up Azure cloud connector |
| url |
string | An IOT central endpoint the user can use to see the data that is being streamed |
Status 4xx
All error messages are returned in this format:
{
"error": "error code string",
"error_description": "error message string",
"cause": "further explanation"
}
Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.