Apps - List By Subscription
Abrufen aller IoT Central-Anwendungen in einem Abonnement.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/iotApps?api-version=2021-06-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
subscription
|
path | True |
string |
Die Abonnement-ID. |
api-version
|
query | True |
string |
Die Version der API. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array der Metadaten aller IoT Central-Anwendungen im Abonnement. |
|
Other Status Codes |
DefaultErrorResponse |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Apps_ListBySubscription
Sample Request
Sample Response
code: 200
{
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/iotApps/myIoTCentralApp",
"location": "westus",
"type": "Microsoft.IoTCentral/IoTApps",
"name": "myIoTCentralApp",
"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": "F1"
},
"identity": {
"type": "SystemAssigned",
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
"principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
}
}
],
"nextLink": null
}
Definitionen
Name | Beschreibung |
---|---|
App |
Die IoT Central-Anwendung. |
App |
Eine Liste der IoT Central-Anwendungen mit einem nächsten Link. |
App |
Der Name der SKU. |
App |
Informationen zur SKU der IoT Central-Anwendung. |
App |
Der aktuelle Status der Anwendung. |
Cloud |
Fehlerdetails. |
Cloud |
Details zur Fehlerantwort. |
System |
Verwaltete Dienstidentität (entweder systemseitig zugewiesen oder keine) |
System |
Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne). |
App
Die IoT Central-Anwendung.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Der ARM-Ressourcenbezeichner. |
identity |
Die verwalteten Identitäten für die IoT Central-Anwendung. |
|
location |
string |
Der Ressourcenspeicherort. |
name |
string |
Der NAME der ARM-Ressource. |
properties.applicationId |
string |
Die ID der Anwendung. |
properties.displayName |
string |
Der Anzeigename der Anwendung. |
properties.state |
Der aktuelle Status der Anwendung. |
|
properties.subdomain |
string |
Die Unterdomäne der Anwendung. |
properties.template |
string |
Die ID der Anwendungsvorlage, bei der es sich um eine Blaupause handelt, die die Merkmale und Das Verhalten einer Anwendung definiert. Optional; wenn nicht angegeben, wird standardmäßig eine leere Blaupause verwendet, und die Anwendung kann von Grund auf neu definiert werden. |
sku |
Eine gültige instance-SKU. |
|
tags |
object |
Die Ressourcentags. |
type |
string |
Der Ressourcentyp. |
AppListResult
Eine Liste der IoT Central-Anwendungen mit einem nächsten Link.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Der Link, der verwendet wird, um die nächste Seite von IoT Central-Anwendungen abzurufen. |
value |
App[] |
Eine Liste der IoT Central-Anwendungen. |
AppSku
Der Name der SKU.
Name | Typ | Beschreibung |
---|---|---|
ST0 |
string |
|
ST1 |
string |
|
ST2 |
string |
AppSkuInfo
Informationen zur SKU der IoT Central-Anwendung.
Name | Typ | Beschreibung |
---|---|---|
name |
Der Name der SKU. |
AppState
Der aktuelle Status der Anwendung.
Name | Typ | Beschreibung |
---|---|---|
created |
string |
|
suspended |
string |
CloudError
Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der Fehlercode. |
error.details |
Eine Liste mit zusätzlichen Details zum Fehler. |
|
error.message |
string |
Die Fehlermeldung. |
error.target |
string |
Das Ziel des bestimmten Fehlers. |
CloudErrorBody
Details zur Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
details |
Eine Liste mit zusätzlichen Details zum Fehler. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Ziel des bestimmten Fehlers. |
SystemAssignedServiceIdentity
Verwaltete Dienstidentität (entweder systemseitig zugewiesen oder keine)
Name | Typ | Beschreibung |
---|---|---|
principalId |
string |
Die Dienstprinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt. |
tenantId |
string |
Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt. |
type |
Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne). |
SystemAssignedServiceIdentityType
Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne).
Name | Typ | Beschreibung |
---|---|---|
None |
string |
|
SystemAssigned |
string |