Apps - Update

Service:

IoT Central

Version d'API:

2021-06-01

Mettez à jour les métadonnées d’une application IoT Central.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient l’application IoT Central.
resourceName	path	True	string	Nom de la ressource ARM de l’application IoT Central.
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l’API.

Corps de la demande

Nom	Type	Description
identity	SystemAssignedServiceIdentity	Identités managées pour l’application IoT Central.
properties.displayName	string	Nom d’affichage de l’application.
properties.subdomain	string	Sous-domaine de l’application.
properties.template	string	ID du modèle d’application, qui est un blueprint qui définit les caractéristiques et les comportements d’une application. Optionnel; s’il n’est pas spécifié, utilise par défaut un blueprint vide et autorise la définition de l’application à partir de zéro.
sku	AppSkuInfo	Référence SKU instance valide.
tags	object	Balises d’instance

Réponses

Nom	Type	Description
200 OK	App	Elle est retournée en réponse à la demande d’interrogation status pour l’opération de création ou de mise à jour. Le corps contient la représentation de ressource qui indique un état d’approvisionnement transitoire.
202 Accepted		Accepté : demande de mise en place acceptée ; l’opération se termine de manière asynchrone.
Other Status Codes	CloudError	DefaultErrorResponse

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Apps_Update

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Code d’état:

202

Code d’état:

default

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

Définitions

Nom	Description
App	Application IoT Central.
AppPatch	Description de l’application IoT Central.
AppSku	Nom de la référence SKU.
AppSkuInfo	Informations sur la référence SKU de l’application IoT Central.
AppState	État actuel de l’application.
CloudError	Détails de l’erreur.
CloudErrorBody	Détails de la réponse d’erreur.
SystemAssignedServiceIdentity	Identité de service managée (affectée par le système ou aucune)
SystemAssignedServiceIdentityType	Type d’identité de service managé (affectée par le système ou aucune).

App

Application IoT Central.

Nom	Type	Description
id	string	Identificateur de ressource ARM.
identity	SystemAssignedServiceIdentity	Identités managées pour l’application IoT Central.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource ARM.
properties.applicationId	string	ID de l’application.
properties.displayName	string	Nom d’affichage de l’application.
properties.state	AppState	État actuel de l’application.
properties.subdomain	string	Sous-domaine de l’application.
properties.template	string	ID du modèle d’application, qui est un blueprint qui définit les caractéristiques et les comportements d’une application. Optionnel; s’il n’est pas spécifié, utilise par défaut un blueprint vide et autorise la définition de l’application à partir de zéro.
sku	AppSkuInfo	Référence SKU instance valide.
tags	object	Étiquettes de la ressource.
type	string	Type de ressource.

AppPatch

Description de l’application IoT Central.

Nom	Type	Description
identity	SystemAssignedServiceIdentity	Identités managées pour l’application IoT Central.
properties.applicationId	string	ID de l’application.
properties.displayName	string	Nom d’affichage de l’application.
properties.state	AppState	État actuel de l’application.
properties.subdomain	string	Sous-domaine de l’application.
properties.template	string	ID du modèle d’application, qui est un blueprint qui définit les caractéristiques et les comportements d’une application. Optionnel; s’il n’est pas spécifié, utilise par défaut un blueprint vide et autorise la définition de l’application à partir de zéro.
sku	AppSkuInfo	Référence SKU instance valide.
tags	object	Balises d’instance

AppSku

Nom de la référence SKU.

Nom	Type	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informations sur la référence SKU de l’application IoT Central.

Nom	Type	Description
name	AppSku	Nom de la référence SKU.

AppState

État actuel de l’application.

Nom	Type	Description
created	string
suspended	string

CloudError

Détails de l’erreur.

Nom	Type	Description
error.code	string	Code d'erreur.
error.details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible de l’erreur particulière.

CloudErrorBody

Détails de la réponse d’erreur.

Nom	Type	Description
code	string	Code d'erreur.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message d’erreur.
target	string	Cible de l’erreur particulière.

SystemAssignedServiceIdentity

Identité de service managée (affectée par le système ou aucune)

Nom	Type	Description
principalId	string	ID de principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	SystemAssignedServiceIdentityType	Type d’identité de service managé (affectée par le système ou aucune).

SystemAssignedServiceIdentityType

Type d’identité de service managé (affectée par le système ou aucune).

Nom	Type	Description
None	string
SystemAssigned	string