Apps - Create Or Update
De metagegevens van een IoT Central-toepassing maken of bijwerken. Het gebruikelijke patroon voor het wijzigen van een eigenschap is om de metagegevens en beveiligingsmetagegevens van de IoT Central-toepassing op te halen en deze vervolgens te combineren met de gewijzigde waarden in een nieuwe hoofdtekst om de IoT Central-toepassing bij te werken.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}?api-version=2021-06-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep die de IoT Central-toepassing bevat. |
resource
|
path | True |
string |
De ARM-resourcenaam van de IoT Central-toepassing. |
subscription
|
path | True |
string |
De abonnements-id. |
api-version
|
query | True |
string |
De versie van de API. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
location | True |
string |
De resourcelocatie. |
sku | True |
Een geldige exemplaar-SKU. |
|
identity |
De beheerde identiteiten voor de IoT Central-toepassing. |
||
properties.displayName |
string |
De weergavenaam van de toepassing. |
|
properties.subdomain |
string |
Het subdomein van de toepassing. |
|
properties.template |
string |
De id van de toepassingssjabloon, een blauwdruk die de kenmerken en het gedrag van een toepassing definieert. Optionele; als dit niet is opgegeven, wordt standaard een lege blauwdruk gebruikt en kan de toepassing helemaal opnieuw worden gedefinieerd. |
|
tags |
object |
De resourcetags. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Dit wordt geretourneerd als reactie op de aanvraag voor de statuspoling voor de bewerking voor het maken of bijwerken. De hoofdtekst bevat de resourceweergave die een overgangsinrichtingsstatus aangeeft. |
|
201 Created |
Dit wordt geretourneerd als reactie op de aanvraag voor de statuspoling voor de bewerking voor het maken of bijwerken. De hoofdtekst bevat de resourceweergave die een overgangsinrichtingsstatus aangeeft. |
|
202 Accepted |
Geaccepteerd - Aanvraag geaccepteerd; de bewerking wordt asynchroon voltooid. |
|
Other Status Codes |
DefaultErrorResponse |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Apps_CreateOrUpdate
Sample Request
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.IoTCentral/iotApps/myIoTCentralApp?api-version=2021-06-01
{
"location": "westus",
"sku": {
"name": "ST2"
},
"properties": {
"displayName": "My IoT Central App",
"subdomain": "my-iot-central-app",
"template": "iotc-pnp-preview@1.0.0"
},
"identity": {
"type": "SystemAssigned"
}
}
Sample Response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp",
"name": "myIoTCentralApp",
"type": "Microsoft.IoTCentral/IoTApps",
"location": "westus",
"tags": {
"key": "value"
},
"properties": {
"applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6",
"displayName": "My IoT Central App 2",
"subdomain": "my-iot-central-app-2",
"template": "iotc-pnp-preview@1.0.0",
"state": "created"
},
"sku": {
"name": "ST2"
},
"identity": {
"type": "SystemAssigned",
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
"principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
}
}
code: 201
message: Created
target: ResourceHandler.ExecutePutRequest
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp",
"name": "myIoTCentralApp",
"type": "Microsoft.IoTCentral/IoTApps",
"location": "westus",
"tags": {
"key": "value"
},
"properties": {
"applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6",
"displayName": "My IoT Central App",
"subdomain": "my-iot-central-app",
"template": "iotc-pnp-preview@1.0.0",
"state": "created"
},
"sku": {
"name": "ST2"
},
"identity": {
"type": "SystemAssigned",
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
"principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
}
}
{
"error": {
"code": "Error code",
"message": "Error message",
"target": "Error target"
}
}
Definities
Name | Description |
---|---|
App |
De IoT Central-toepassing. |
App |
De naam van de SKU. |
App |
Informatie over de SKU van de IoT Central-toepassing. |
App |
De huidige status van de toepassing. |
Cloud |
Foutdetails. |
Cloud |
Details van de foutreactie. |
System |
Beheerde service-identiteit (door het systeem toegewezen of geen) |
System |
Type beheerde service-identiteit (door het systeem toegewezen of geen). |
App
De IoT Central-toepassing.
Name | Type | Description |
---|---|---|
id |
string |
De ARM-resource-id. |
identity |
De beheerde identiteiten voor de IoT Central-toepassing. |
|
location |
string |
De resourcelocatie. |
name |
string |
De naam van de ARM-resource. |
properties.applicationId |
string |
De id van de toepassing. |
properties.displayName |
string |
De weergavenaam van de toepassing. |
properties.state |
De huidige status van de toepassing. |
|
properties.subdomain |
string |
Het subdomein van de toepassing. |
properties.template |
string |
De id van de toepassingssjabloon, een blauwdruk die de kenmerken en het gedrag van een toepassing definieert. Optionele; als dit niet is opgegeven, wordt standaard een lege blauwdruk gebruikt en kan de toepassing helemaal opnieuw worden gedefinieerd. |
sku |
Een geldige exemplaar-SKU. |
|
tags |
object |
De resourcetags. |
type |
string |
Het resourcetype. |
AppSku
De naam van de SKU.
Name | Type | Description |
---|---|---|
ST0 |
string |
|
ST1 |
string |
|
ST2 |
string |
AppSkuInfo
Informatie over de SKU van de IoT Central-toepassing.
Name | Type | Description |
---|---|---|
name |
De naam van de SKU. |
AppState
De huidige status van de toepassing.
Name | Type | Description |
---|---|---|
created |
string |
|
suspended |
string |
CloudError
Foutdetails.
Name | Type | Description |
---|---|---|
error.code |
string |
De foutcode. |
error.details |
Een lijst met aanvullende informatie over de fout. |
|
error.message |
string |
Het foutbericht. |
error.target |
string |
Het doel van de specifieke fout. |
CloudErrorBody
Details van de foutreactie.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
details |
Een lijst met aanvullende informatie over de fout. |
|
message |
string |
Het foutbericht. |
target |
string |
Het doel van de specifieke fout. |
SystemAssignedServiceIdentity
Beheerde service-identiteit (door het systeem toegewezen of geen)
Name | Type | Description |
---|---|---|
principalId |
string |
De service-principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit. |
tenantId |
string |
De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit. |
type |
Type beheerde service-identiteit (door het systeem toegewezen of geen). |
SystemAssignedServiceIdentityType
Type beheerde service-identiteit (door het systeem toegewezen of geen).
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |