Apps - List By Resource Group

참조

Service:: IoT Central

API Version:: 2021-06-01

리소스 그룹의 모든 IoT Central 애플리케이션을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	IoT Central 애플리케이션을 포함하는 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	구독 식별자입니다.
api-version	query	True	string	API 버전입니다.

응답

Name	형식	Description
200 OK	AppListResult	동기 작업입니다. 본문에는 리소스 그룹의 모든 IoT Central 애플리케이션에서 JSON으로 직렬화된 메타데이터 배열이 포함됩니다.
Other Status Codes	CloudError	DefaultErrorResponse

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

Apps_ListByResourceGroup

Sample Request

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

import com.azure.core.util.Context;

/** Samples for Apps ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_ListByResourceGroup.json
     */
    /**
     * Sample code: Apps_ListByResourceGroup.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsListByResourceGroup(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        manager.apps().listByResourceGroup("resRg", 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_resource_group.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_resource_group(
        resource_group_name="resRg",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_ListByResourceGroup.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_ListByResourceGroup.json
func ExampleAppsClient_NewListByResourceGroupPager() {
	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().NewListByResourceGroupPager("resRg", 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
}

Status code:: default

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

정의

Name	Description
App	IoT Central 애플리케이션.
AppListResult	다음 링크가 있는 IoT Central 애플리케이션 목록입니다.
AppSku	SKU의 이름입니다.
AppSkuInfo	IoT Central 애플리케이션의 SKU에 대한 정보입니다.
AppState	애플리케이션의 현재 상태입니다.
CloudError	오류 세부 정보입니다.
CloudErrorBody	오류 응답에 대한 세부 정보입니다.
SystemAssignedServiceIdentity	관리 서비스 ID(시스템 할당 또는 없음)
SystemAssignedServiceIdentityType	관리 서비스 ID 유형(시스템 할당 또는 없음)

App

IoT Central 애플리케이션.

Name	형식	Description
id	string	ARM 리소스 식별자입니다.
identity	SystemAssignedServiceIdentity	IoT Central 애플리케이션에 대한 관리 ID입니다.
location	string	리소스 위치입니다.
name	string	ARM 리소스 이름입니다.
properties.applicationId	string	애플리케이션의 ID입니다.
properties.displayName	string	애플리케이션의 표시 이름입니다.
properties.state	AppState	애플리케이션의 현재 상태입니다.
properties.subdomain	string	애플리케이션의 하위 도메인입니다.
properties.template	string	애플리케이션의 특성과 동작을 정의하는 청사진인 애플리케이션 템플릿의 ID입니다. 선택적; 지정하지 않으면 기본적으로 빈 청사진으로 설정되며 애플리케이션을 처음부터 정의할 수 있습니다.
sku	AppSkuInfo	유효한 instance SKU입니다.
tags	object	리소스 태그입니다.
type	string	리소스 종류입니다.

AppListResult

다음 링크가 있는 IoT Central 애플리케이션 목록입니다.

Name	형식	Description
nextLink	string	IoT Central 애플리케이션의 다음 페이지를 가져오는 데 사용되는 링크입니다.
value	App[]	IoT Central 애플리케이션 목록입니다.

AppSku

SKU의 이름입니다.

Name	형식	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

IoT Central 애플리케이션의 SKU에 대한 정보입니다.

Name	형식	Description
name	AppSku	SKU의 이름입니다.

AppState

애플리케이션의 현재 상태입니다.

Name	형식	Description
created	string
suspended	string

CloudError

오류 세부 정보입니다.

Name	형식	Description
error.code	string	오류 코드입니다.
error.details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
error.message	string	오류 메시지입니다.
error.target	string	특정 오류의 대상입니다.

CloudErrorBody

오류 응답에 대한 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	오류 메시지입니다.
target	string	특정 오류의 대상입니다.

SystemAssignedServiceIdentity

관리 서비스 ID(시스템 할당 또는 없음)

Name	형식	Description
principalId	string	시스템 할당 ID의 서비스 주체 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
tenantId	string	시스템 할당 ID의 테넌트 ID입니다. 이 속성은 시스템 할당 ID에 대해서만 제공됩니다.
type	SystemAssignedServiceIdentityType	관리 서비스 ID 유형(시스템 할당 또는 없음)

SystemAssignedServiceIdentityType

관리 서비스 ID 유형(시스템 할당 또는 없음)

Name	형식	Description
None	string
SystemAssigned	string

다음을 통해 공유

Apps - List By Resource Group

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

Apps_ListByResourceGroup

Sample Request

Sample Response

정의

App

AppListResult

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

추가 리소스