Apps - Create Or Update

Riferimento

Service:: IoT Central

API Version:: 2021-06-01

Creare o aggiornare i metadati di un'applicazione IoT Central. Il modello consueto per modificare una proprietà consiste nel recuperare i metadati e i metadati di sicurezza dell'applicazione IoT Central e quindi combinarli con i valori modificati in un nuovo corpo per aggiornare l'applicazione IoT Central.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente l'applicazione IoT Central.
resourceName	path	True	string	Nome della risorsa ARM dell'applicazione IoT Central.
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Percorso della risorsa.
sku	True	AppSkuInfo	SKU di istanza valido.
identity		SystemAssignedServiceIdentity	Identità gestite per l'applicazione IoT Central.
properties.displayName		string	Nome visualizzato dell'applicazione.
properties.subdomain		string	Sottodominio dell'applicazione.
properties.template		string	ID del modello di applicazione, che è un progetto che definisce le caratteristiche e i comportamenti di un'applicazione. Opzionale; se non specificato, il valore predefinito è un progetto vuoto e consente di definire l'applicazione da zero.
tags		object	Tag di risorsa.

Risposte

Nome	Tipo	Descrizione
200 OK	App	Viene restituito come risposta alla richiesta di polling dello stato per l'operazione di creazione o aggiornamento. Il corpo contiene la rappresentazione della risorsa che indica uno stato di provisioning transitorio.
201 Created	App	Viene restituito come risposta alla richiesta di polling dello stato per l'operazione di creazione o aggiornamento. Il corpo contiene la rappresentazione della risorsa che indica uno stato di provisioning transitorio.
202 Accepted		Accettato - Inserire la richiesta accettata; l'operazione verrà completata in modo asincrono.
Other Status Codes	CloudError	DefaultErrorResponse

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
App	Applicazione IoT Central.
AppSku	Il nome della SKU.
AppSkuInfo	Informazioni sullo SKU dell'applicazione IoT Central.
AppState	Stato attuale dell'applicazione.
CloudError	Dettagli degli errori.
CloudErrorBody	Dettagli della risposta all'errore.
SystemAssignedServiceIdentity	Identità del servizio gestita (assegnata dal sistema o none)
SystemAssignedServiceIdentityType	Tipo di identità del servizio gestito (sistema assegnato o none).

App

Applicazione IoT Central.

Nome	Tipo	Descrizione
id	string	Identificatore di risorsa arm.
identity	SystemAssignedServiceIdentity	Identità gestite per l'applicazione IoT Central.
location	string	Percorso della risorsa.
name	string	Nome della risorsa ARM.
properties.applicationId	string	ID dell'applicazione.
properties.displayName	string	Nome visualizzato dell'applicazione.
properties.state	AppState	Stato attuale dell'applicazione.
properties.subdomain	string	Sottodominio dell'applicazione.
properties.template	string	ID del modello di applicazione, che è un progetto che definisce le caratteristiche e i comportamenti di un'applicazione. Opzionale; se non specificato, il valore predefinito è un progetto vuoto e consente di definire l'applicazione da zero.
sku	AppSkuInfo	SKU di istanza valido.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa.

AppSku

Il nome della SKU.

Nome	Tipo	Descrizione
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informazioni sullo SKU dell'applicazione IoT Central.

Nome	Tipo	Descrizione
name	AppSku	Il nome della SKU.

AppState

Stato attuale dell'applicazione.

Nome	Tipo	Descrizione
created	string
suspended	string

CloudError

Dettagli degli errori.

Nome	Tipo	Descrizione
error.code	string	Codice di errore.
error.details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
error.message	string	Messaggio di errore.
error.target	string	Destinazione dell'errore specifico.

CloudErrorBody

Dettagli della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

SystemAssignedServiceIdentity

Identità del servizio gestita (assegnata dal sistema o none)

Nome	Tipo	Descrizione
principalId	string	ID dell'entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
tenantId	string	ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
type	SystemAssignedServiceIdentityType	Tipo di identità del servizio gestito (sistema assegnato o none).

SystemAssignedServiceIdentityType

Tipo di identità del servizio gestito (sistema assegnato o none).

Nome	Tipo	Descrizione
None	string
SystemAssigned	string

Condividi tramite