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

Apps - Create Or Update

参考

Service:: IoT Central

API Version:: 2021-06-01

创建或更新 IoT Central 应用程序的元数据。修改属性的常用模式是检索 IoT Central 应用程序元数据和安全元数据，然后将它们与新正文中的修改值合并，以更新 IoT Central 应用程序。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	包含 IoT Central 应用程序的资源组的名称。
resourceName	path	True	string	IoT Central 应用程序的 ARM 资源名称。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

请求正文

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

响应

名称	类型	说明
200 OK	App	这是作为对创建或更新操作的状态轮询请求的响应返回的。正文包含指示过渡预配状态的资源表示形式。
201 Created	App	这是作为对创建或更新操作的状态轮询请求的响应返回的。正文包含指示过渡预配状态的资源表示形式。
202 Accepted		已接受 - 接受放置请求;操作将以异步方式完成。
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_CreateOrUpdate

Sample Request

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

{
  "location": "westus",
  "sku": {
    "name": "ST2"
  },
  "properties": {
    "displayName": "My IoT Central App",
    "subdomain": "my-iot-central-app",
    "template": "iotc-pnp-preview@1.0.0"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

import com.azure.resourcemanager.iotcentral.models.AppSku;
import com.azure.resourcemanager.iotcentral.models.AppSkuInfo;
import com.azure.resourcemanager.iotcentral.models.SystemAssignedServiceIdentity;
import com.azure.resourcemanager.iotcentral.models.SystemAssignedServiceIdentityType;

/** Samples for Apps CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_CreateOrUpdate.json
     */
    /**
     * Sample code: Apps_CreateOrUpdate.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsCreateOrUpdate(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        manager
            .apps()
            .define("myIoTCentralApp")
            .withRegion("westus")
            .withExistingResourceGroup("resRg")
            .withSku(new AppSkuInfo().withName(AppSku.ST2))
            .withIdentity(
                new SystemAssignedServiceIdentity().withType(SystemAssignedServiceIdentityType.SYSTEM_ASSIGNED))
            .withDisplayName("My IoT Central App")
            .withSubdomain("my-iot-central-app")
            .withTemplate("iotc-pnp-preview@1.0.0")
            .create();
    }
}

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/azcore/to"
	"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_CreateOrUpdate.json
func ExampleAppsClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewAppsClient().BeginCreateOrUpdate(ctx, "resRg", "myIoTCentralApp", armiotcentral.App{
		Location: to.Ptr("westus"),
		Identity: &armiotcentral.SystemAssignedServiceIdentity{
			Type: to.Ptr(armiotcentral.SystemAssignedServiceIdentityTypeSystemAssigned),
		},
		Properties: &armiotcentral.AppProperties{
			DisplayName: to.Ptr("My IoT Central App"),
			Subdomain:   to.Ptr("my-iot-central-app"),
			Template:    to.Ptr("iotc-pnp-preview@1.0.0"),
		},
		SKU: &armiotcentral.AppSKUInfo{
			Name: to.Ptr(armiotcentral.AppSKUST2),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.App = 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 2"),
	// 		State: to.Ptr(armiotcentral.AppStateCreated),
	// 		Subdomain: to.Ptr("my-iot-central-app-2"),
	// 		Template: to.Ptr("iotc-pnp-preview@1.0.0"),
	// 	},
	// 	SKU: &armiotcentral.AppSKUInfo{
	// 		Name: to.Ptr(armiotcentral.AppSKUST2),
	// 	},
	// }
}

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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp",
  "name": "myIoTCentralApp",
  "type": "Microsoft.IoTCentral/IoTApps",
  "location": "westus",
  "tags": {
    "key": "value"
  },
  "properties": {
    "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6",
    "displayName": "My IoT Central App 2",
    "subdomain": "my-iot-central-app-2",
    "template": "iotc-pnp-preview@1.0.0",
    "state": "created"
  },
  "sku": {
    "name": "ST2"
  },
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
  }
}

Status code:: 201

code: 201
message: Created
target: ResourceHandler.ExecutePutRequest

Response Body

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp",
  "name": "myIoTCentralApp",
  "type": "Microsoft.IoTCentral/IoTApps",
  "location": "westus",
  "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": "ST2"
  },
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
  }
}

Status code:: 202

Status code:: default

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

定义

名称	说明
App	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	资源类型。

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