Apps - List By Resource Group

Odwołanie

Service:: IoT Central

API Version:: 2018-09-01

Pobierz wszystkie aplikacje usługi IoT Central w grupie zasobów.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps?api-version=2018-09-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej aplikację usługi IoT Central.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AppListResult	Jest to operacja synchroniczna. Treść zawiera tablicę serializowaną w formacie JSON metadanych ze wszystkich aplikacji usługi IoT Central w grupie zasobów.
Other Status Codes	CloudError	DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Apps_ListByResourceGroup

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.IoTCentral/iotApps?api-version=2018-09-01

Sample Response

Status code:: 200

code: 200

Response Body

{
  "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-default@1.0.0"
      },
      "sku": {
        "name": "F1"
      }
    }
  ],
  "nextLink": null
}

Status code:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message",
    "target": "Error target"
  }
}

Definicje

Nazwa	Opis
App	Aplikacja usługi IoT Central.
AppListResult	Lista aplikacji usługi IoT Central z następnym linkiem.
AppSku	Nazwa jednostki SKU.
AppSkuInfo	Informacje o jednostce SKU aplikacji usługi IoT Central.
AppState	Bieżący stan aplikacji.
CloudError	Szczegóły błędu.
CloudErrorBody	Szczegóły odpowiedzi na błąd.

App

Aplikacja usługi IoT Central.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi ARM.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu usługi ARM.
properties.applicationId	string	Identyfikator aplikacji.
properties.displayName	string	Nazwa wyświetlana aplikacji.
properties.geography	string	Lokalizacja geograficzna aplikacji.
properties.state	AppState	Bieżący stan aplikacji.
properties.subdomain	string	Poddomena aplikacji.
properties.template	string	Identyfikator szablonu aplikacji, który jest strategią definiującą charakterystykę i zachowania aplikacji. Opcjonalne; Jeśli nie zostanie określony, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw.
properties.tenant	string	Identyfikator dzierżawy, do którego należy aplikacja.
properties.thumbnailUrl	string	Identyfikator URI obrazu miniatury używanego w aplikacji.
sku	AppSkuInfo	Prawidłowa jednostka SKU wystąpienia.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

AppListResult

Lista aplikacji usługi IoT Central z następnym linkiem.

Nazwa	Typ	Opis
nextLink	string	Link umożliwiający pobranie następnej strony aplikacji usługi IoT Central.
value	App[]	Lista aplikacji usługi IoT Central.

AppSku

Nazwa jednostki SKU.

Nazwa	Typ	Opis
F1	string
S1	string
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informacje o jednostce SKU aplikacji usługi IoT Central.

Nazwa	Typ	Opis
name	AppSku	Nazwa jednostki SKU.

AppState

Bieżący stan aplikacji.

Nazwa	Typ	Opis
created	string
suspended	string

CloudError

Szczegóły błędu.

Nazwa	Typ	Opis
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy określonego błędu.

CloudErrorBody

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.