Apps - Update

Služba:

IoT Central

Verze rozhraní API:

2021-06-01

Aktualizujte metadata aplikace IoT Central.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje aplikaci IoT Central.
resourceName	path	True	string	Název prostředku ARM aplikace IoT Central.
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API

Text požadavku

Name	Typ	Description
identity	SystemAssignedServiceIdentity	Spravované identity pro aplikaci IoT Central.
properties.displayName	string	Zobrazovaný název aplikace.
properties.subdomain	string	Subdoména aplikace.
properties.template	string	ID šablony aplikace, což je podrobný plán, který definuje charakteristiky a chování aplikace. Volitelné; Pokud není zadaný, ve výchozím nastavení se použije prázdný podrobný plán a umožňuje definovat aplikaci úplně od začátku.
sku	AppSkuInfo	Platná skladová položka instance.
tags	object	Značky instancí

Odpovědi

Name	Typ	Description
200 OK	App	Vrátí se jako odpověď na požadavek dotazování stavu pro operaci vytvoření nebo aktualizace. Tělo obsahuje reprezentaci prostředku, která označuje přechodný stav zřizování.
202 Accepted		Přijato – Žádost o zadání byla přijata; operace se dokončí asynchronně.
Other Status Codes	CloudError	DefaultErrorResponse

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Apps_Update

Ukázkový požadavek

HTTP

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

Java

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

Go

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

Ukázková odpověď

Stavový kód:

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

Stavový kód:

202

Stavový kód:

default

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

Definice

Name	Description
App	Aplikace IoT Central.
AppPatch	Popis aplikace IoT Central
AppSku	Název skladové položky.
AppSkuInfo	Informace o skladové pouce aplikace IoT Central
AppState	Aktuální stav aplikace.
CloudError	Podrobnosti o chybě.
CloudErrorBody	Podrobnosti o odpovědi na chybu
SystemAssignedServiceIdentity	Identita spravované služby (přiřazená systémem nebo žádná)
SystemAssignedServiceIdentityType	Typ identity spravované služby (buď přiřazený systémem, nebo žádný).

App

Aplikace IoT Central.

Name	Typ	Description
id	string	Identifikátor prostředku ARM.
identity	SystemAssignedServiceIdentity	Spravované identity pro aplikaci IoT Central.
location	string	Umístění prostředku.
name	string	Název prostředku ARM.
properties.applicationId	string	ID aplikace.
properties.displayName	string	Zobrazovaný název aplikace.
properties.state	AppState	Aktuální stav aplikace.
properties.subdomain	string	Subdoména aplikace.
properties.template	string	ID šablony aplikace, což je podrobný plán, který definuje charakteristiky a chování aplikace. Volitelné; Pokud není zadaný, ve výchozím nastavení se použije prázdný podrobný plán a umožňuje definovat aplikaci úplně od začátku.
sku	AppSkuInfo	Platná skladová položka instance.
tags	object	Značky prostředků.
type	string	Typ prostředku.

AppPatch

Popis aplikace IoT Central

Name	Typ	Description
identity	SystemAssignedServiceIdentity	Spravované identity pro aplikaci IoT Central.
properties.applicationId	string	ID aplikace.
properties.displayName	string	Zobrazovaný název aplikace.
properties.state	AppState	Aktuální stav aplikace.
properties.subdomain	string	Subdoména aplikace.
properties.template	string	ID šablony aplikace, což je podrobný plán, který definuje charakteristiky a chování aplikace. Volitelné; Pokud není zadaný, ve výchozím nastavení se použije prázdný podrobný plán a umožňuje definovat aplikaci úplně od začátku.
sku	AppSkuInfo	Platná skladová položka instance.
tags	object	Značky instancí

AppSku

Název skladové položky.

Name	Typ	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informace o skladové pouce aplikace IoT Central

Name	Typ	Description
name	AppSku	Název skladové položky.

AppState

Aktuální stav aplikace.

Name	Typ	Description
created	string
suspended	string

CloudError

Podrobnosti o chybě.

Name	Typ	Description
error.code	string	Kód chyby
error.details	CloudErrorBody[]	Seznam dalších podrobností o chybě
error.message	string	Chybová zpráva
error.target	string	Cíl konkrétní chyby.

CloudErrorBody

Podrobnosti o odpovědi na chybu

Name	Typ	Description
code	string	Kód chyby
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Chybová zpráva
target	string	Cíl konkrétní chyby.

SystemAssignedServiceIdentity

Identita spravované služby (přiřazená systémem nebo žádná)

Name	Typ	Description
principalId	string	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
type	SystemAssignedServiceIdentityType	Typ identity spravované služby (buď přiřazený systémem, nebo žádný).

SystemAssignedServiceIdentityType

Typ identity spravované služby (buď přiřazený systémem, nebo žádný).

Name	Typ	Description
None	string
SystemAssigned	string