Apps - List By Subscription

Referenz

Service:: IoT Central

API Version:: 2021-06-01

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
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Antworten

Name	Typ	Beschreibung
200 OK	AppListResult	Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array der Metadaten aller IoT Central-Anwendungen im Abonnement.
Other Status Codes	CloudError	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

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/iotApps?api-version=2021-06-01

import com.azure.core.util.Context;

/** Samples for Apps List. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_ListBySubscription.json
     */
    /**
     * Sample code: Apps_ListBySubscription.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsListBySubscription(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        manager.apps().list(Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.iotcentral import IotCentralClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iotcentral
# USAGE
    python apps_list_by_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IotCentralClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.apps.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_ListBySubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armiotcentral_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iotcentral/armiotcentral"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_ListBySubscription.json
func ExampleAppsClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiotcentral.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAppsClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AppListResult = armiotcentral.AppListResult{
		// 	Value: []*armiotcentral.App{
		// 		{
		// 			Name: to.Ptr("myIoTCentralApp"),
		// 			Type: to.Ptr("Microsoft.IoTCentral/IoTApps"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/iotApps/myIoTCentralApp"),
		// 			Location: to.Ptr("westus"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Identity: &armiotcentral.SystemAssignedServiceIdentity{
		// 				Type: to.Ptr(armiotcentral.SystemAssignedServiceIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("8988ab15-3e7a-4586-8a1c-ed07a73a53e9"),
		// 				TenantID: to.Ptr("f686d426-8d16-42db-81b7-ab578e110ccd"),
		// 			},
		// 			Properties: &armiotcentral.AppProperties{
		// 				ApplicationID: to.Ptr("6ebd8fd3-6e34-419e-908f-9be61ec6f6d6"),
		// 				DisplayName: to.Ptr("My IoT Central App"),
		// 				State: to.Ptr(armiotcentral.AppStateCreated),
		// 				Subdomain: to.Ptr("my-iot-central-app"),
		// 				Template: to.Ptr("iotc-pnp-preview@1.0.0"),
		// 			},
		// 			SKU: &armiotcentral.AppSKUInfo{
		// 				Name: to.Ptr(armiotcentral.AppSKU("F1")),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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-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.
AppListResult	Eine Liste der IoT Central-Anwendungen mit einem nächsten Link.
AppSku	Der Name der SKU.
AppSkuInfo	Informationen zur SKU der IoT Central-Anwendung.
AppState	Der aktuelle Status der Anwendung.
CloudError	Fehlerdetails.
CloudErrorBody	Details zur Fehlerantwort.
SystemAssignedServiceIdentity	Verwaltete Dienstidentität (entweder systemseitig zugewiesen oder keine)
SystemAssignedServiceIdentityType	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	SystemAssignedServiceIdentity	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	AppState	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	AppSkuInfo	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	AppSku	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	CloudErrorBody[]	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	CloudErrorBody[]	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	SystemAssignedServiceIdentityType	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

Share via

Apps - List By Subscription

URI-Parameter

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Apps_ListBySubscription

Sample Request

Sample Response

Definitionen

App

AppListResult

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Zusätzliche Ressourcen