你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Apps - List By Subscription

参考

Service:: IoT Central

API Version:: 2021-06-01

获取订阅中的所有 IoT Central 应用程序。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/iotApps?api-version=2021-06-01

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

响应

名称	类型	说明
200 OK	AppListResult	这是一个同步操作。正文包含订阅中所有 IoT Central 应用程序的元数据的 JSON 序列化数组。
Other Status Codes	CloudError	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

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
}

定义

名称	说明
App	IoT Central 应用程序。
AppListResult	包含下一个链接的 IoT Central 应用程序列表。
AppSku	SKU 的名称。
AppSkuInfo	有关 IoT Central 应用程序的 SKU 的信息。
AppState	应用程序的当前状态。
CloudError	错误详细信息。
CloudErrorBody	错误响应的详细信息。
SystemAssignedServiceIdentity	托管服务标识 (系统分配或无)
SystemAssignedServiceIdentityType	托管服务标识的类型 (系统分配或无) 。

App

IoT Central 应用程序。

名称	类型	说明
id	string	ARM 资源标识符。
identity	SystemAssignedServiceIdentity	IoT Central 应用程序的托管标识。
location	string	资源位置。
name	string	ARM 资源名称。
properties.applicationId	string	应用程序的 ID。
properties.displayName	string	应用程序的显示名称。
properties.state	AppState	应用程序的当前状态。
properties.subdomain	string	应用程序的子域。
properties.template	string	应用程序模板的 ID，它是定义应用程序的特征和行为的蓝图。选;如果未指定，则默认为空白蓝图，并允许从头开始定义应用程序。
sku	AppSkuInfo	有效的实例 SKU。
tags	object	资源标记。
type	string	资源类型。

AppListResult

包含下一个链接的 IoT Central 应用程序列表。

名称	类型	说明
nextLink	string	用于获取 IoT Central 应用程序的下一页的链接。
value	App[]	IoT Central 应用程序的列表。

AppSku

SKU 的名称。

名称	类型	说明
ST0	string
ST1	string
ST2	string

AppSkuInfo

有关 IoT Central 应用程序的 SKU 的信息。

名称	类型	说明
name	AppSku	SKU 的名称。

AppState

应用程序的当前状态。

名称	类型	说明
created	string
suspended	string

CloudError

错误详细信息。

名称	类型	说明
error.code	string	错误代码。
error.details	CloudErrorBody[]	有关错误的其他详细信息的列表。
error.message	string	错误消息。
error.target	string	特定错误的目标。

CloudErrorBody

错误响应的详细信息。

名称	类型	说明
code	string	错误代码。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	错误消息。
target	string	特定错误的目标。

SystemAssignedServiceIdentity

托管服务标识 (系统分配或无)

名称	类型	说明
principalId	string	系统分配的标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	系统分配的标识的租户 ID。此属性仅针对系统分配的标识提供。
type	SystemAssignedServiceIdentityType	托管服务标识的类型 (系统分配或无) 。

SystemAssignedServiceIdentityType

托管服务标识的类型 (系统分配或无) 。

名称	类型	说明
None	string
SystemAssigned	string

Apps - List By Subscription

URI 参数

响应

安全性

azure_auth

Scopes

示例

Apps_ListBySubscription

Sample Request

Sample Response

定义

App

AppListResult

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

其他资源