Apps - Update

參考

服務:: IoT Central

API 版本:: 2021-06-01

更新IoT Central應用程式的元數據。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含IoT Central應用程式的資源群組名稱。
resourceName	path	True	string	IoT Central 應用程式的 ARM 資源名稱。
subscriptionId	path	True	string	訂用帳戶識別碼。
api-version	query	True	string	API 的版本。

要求本文

名稱	類型	Description
identity	SystemAssignedServiceIdentity	IoT Central 應用程式的受控識別。
properties.displayName	string	應用程式的顯示名稱。
properties.subdomain	string	應用程式的子域。
properties.template	string	應用程式範本的識別碼，這是定義應用程式特性和行為的藍圖。選;如果未指定，則預設為空白藍圖，並允許從頭定義應用程式。
sku	AppSkuInfo	有效的實例 SKU。
tags	object	實例標記

回應

名稱	類型	Description
200 OK	App	這會以回應建立或更新作業的狀態輪詢要求傳回。本文包含表示過渡布建狀態的資源表示法。
202 Accepted		已接受 - 接受要求;作業會以異步方式完成。
Other Status Codes	CloudError	DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Apps_Update

範例要求

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

{
  "properties": {
    "displayName": "My IoT Central App 2"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.iotcentral.models.App;
import com.azure.resourcemanager.iotcentral.models.SystemAssignedServiceIdentity;
import com.azure.resourcemanager.iotcentral.models.SystemAssignedServiceIdentityType;

/** Samples for Apps Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_Update.json
     */
    /**
     * Sample code: Apps_Update.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsUpdate(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        App resource =
            manager.apps().getByResourceGroupWithResponse("resRg", "myIoTCentralApp", Context.NONE).getValue();
        resource
            .update()
            .withIdentity(
                new SystemAssignedServiceIdentity().withType(SystemAssignedServiceIdentityType.SYSTEM_ASSIGNED))
            .withDisplayName("My IoT Central App 2")
            .apply();
    }
}

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_Update.json
func ExampleAppsClient_BeginUpdate() {
	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().BeginUpdate(ctx, "resRg", "myIoTCentralApp", armiotcentral.AppPatch{
		Identity: &armiotcentral.SystemAssignedServiceIdentity{
			Type: to.Ptr(armiotcentral.SystemAssignedServiceIdentityTypeSystemAssigned),
		},
		Properties: &armiotcentral.AppProperties{
			DisplayName: to.Ptr("My IoT Central App 2"),
		},
	}, 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

範例回覆

狀態碼:: 200

code: 200
message: OK
target: ResourceHandler.ExecutePatchRequest

{
  "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 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"
  }
}

狀態碼:: 202

狀態碼:: default

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

定義

名稱	Description
App	IoT Central 應用程式。
AppPatch	IoT Central 應用程式的描述。
AppSku	SKU 的名稱。
AppSkuInfo	IoT Central 應用程式的 SKU 相關信息。
AppState	應用程式的目前狀態。
CloudError	錯誤詳細數據。
CloudErrorBody	錯誤回應的詳細數據。
SystemAssignedServiceIdentity	受控服務識別 (系統指派或無)
SystemAssignedServiceIdentityType	受管理的服務識別類型 (系統指派或無) 。

App

IoT Central 應用程式。

名稱	類型	Description
id	string	ARM 資源標識碼。
identity	SystemAssignedServiceIdentity	IoT Central 應用程式的受控識別。
location	string	資源位置。
name	string	ARM 資源名稱。
properties.applicationId	string	應用程式的識別碼。
properties.displayName	string	應用程式的顯示名稱。
properties.state	AppState	應用程式的目前狀態。
properties.subdomain	string	應用程式的子域。
properties.template	string	應用程式範本的識別碼，這是定義應用程式特性和行為的藍圖。選;如果未指定，則預設為空白藍圖，並允許從頭定義應用程式。
sku	AppSkuInfo	有效的實例 SKU。
tags	object	資源標籤。
type	string	資源類型。

AppPatch

IoT Central 應用程式的描述。

名稱	類型	Description
identity	SystemAssignedServiceIdentity	IoT Central 應用程式的受控識別。
properties.applicationId	string	應用程式的識別碼。
properties.displayName	string	應用程式的顯示名稱。
properties.state	AppState	應用程式的目前狀態。
properties.subdomain	string	應用程式的子域。
properties.template	string	應用程式範本的識別碼，這是定義應用程式特性和行為的藍圖。選;如果未指定，則預設為空白藍圖，並允許從頭定義應用程式。
sku	AppSkuInfo	有效的實例 SKU。
tags	object	實例標記

AppSku

SKU 的名稱。

名稱	類型	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

IoT Central 應用程式的 SKU 相關信息。

名稱	類型	Description
name	AppSku	SKU 的名稱。

AppState

應用程式的目前狀態。

名稱	類型	Description
created	string
suspended	string

CloudError

錯誤詳細數據。

名稱	類型	Description
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤的其他詳細數據清單。
error.message	string	錯誤訊息。
error.target	string	特定錯誤的目標。

CloudErrorBody

錯誤回應的詳細數據。

名稱	類型	Description
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	錯誤訊息。
target	string	特定錯誤的目標。

SystemAssignedServiceIdentity

受控服務識別 (系統指派或無)

名稱	類型	Description
principalId	string	系統指派身分識別的服務主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	SystemAssignedServiceIdentityType	受管理的服務識別類型 (系統指派或無) 。

SystemAssignedServiceIdentityType

受管理的服務識別類型 (系統指派或無) 。

名稱	類型	Description
None	string
SystemAssigned	string

共用方式為