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 パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	IoT Central アプリケーションを含むリソースグループの名前。
resourceName	path	True	string	IoT Central アプリケーションの ARM リソース名。
subscriptionId	path	True	string	サブスクリプションの識別子です。
api-version	query	True	string	API のバージョン。

要求本文

名前	型	説明
identity	SystemAssignedServiceIdentity	IoT Central アプリケーションのマネージド ID。
properties.displayName	string	アプリケーションの表示名。
properties.subdomain	string	アプリケーションのサブドメイン。
properties.template	string	アプリケーションテンプレートの ID。これは、アプリケーションの特性と動作を定義するブループリントです。オプション;指定しない場合、既定では空白のブループリントが使用され、アプリケーションを最初から定義できます。
sku	AppSkuInfo	有効なインスタンス SKU。
tags	object	インスタンスタグ

応答

名前	型	説明
200 OK	App	これは、作成または更新操作の状態ポーリング要求への応答として返されます。本文には、移行プロビジョニング状態を示すリソース表現が含まれています。
202 Accepted		受け入れ済み - Put 要求が受け入れられます。操作は非同期的に完了します。
Other Status Codes	CloudError	DefaultErrorResponse

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
  }
}

定義

名前	説明
App	IoT Central アプリケーション。
AppPatch	IoT Central アプリケーションの説明。
AppSku	SKU の名前。
AppSkuInfo	IoT Central アプリケーションの SKU に関する情報。
AppState	アプリケーションの現在の状態。
CloudError	エラーの詳細。
CloudErrorBody	エラー応答の詳細。
SystemAssignedServiceIdentity	マネージドサービス ID (システム割り当て済み、またはなし)
SystemAssignedServiceIdentityType	マネージドサービス ID の種類 (システム割り当て済み、またはなし)。

App

IoT Central アプリケーション。

名前	型	説明
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	有効なインスタンス SKU。
tags	object	リソースタグ。
type	string	リソースの種類。

AppPatch

IoT Central アプリケーションの説明。

名前	型	説明
identity	SystemAssignedServiceIdentity	IoT Central アプリケーションのマネージド ID。
properties.applicationId	string	アプリケーションの ID。
properties.displayName	string	アプリケーションの表示名。
properties.state	AppState	アプリケーションの現在の状態。
properties.subdomain	string	アプリケーションのサブドメイン。
properties.template	string	アプリケーションテンプレートの ID。これは、アプリケーションの特性と動作を定義するブループリントです。オプション;指定しない場合、既定では空白のブループリントが使用され、アプリケーションを最初から定義できます。
sku	AppSkuInfo	有効なインスタンス SKU。
tags	object	インスタンスタグ

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

マネージドサービス ID (システム割り当て済み、またはなし)

名前	型	説明
principalId	string	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
type	SystemAssignedServiceIdentityType	マネージドサービス ID の種類 (システム割り当て済み、またはなし)。

SystemAssignedServiceIdentityType

マネージドサービス ID の種類 (システム割り当て済み、またはなし)。

名前	型	説明
None	string
SystemAssigned	string

次の方法で共有