Apps - Create Or Update

Odwołanie

Service:: IoT Central

API Version:: 2021-06-01

Tworzenie lub aktualizowanie metadanych aplikacji usługi IoT Central. Typowym wzorcem modyfikowania właściwości jest pobranie metadanych aplikacji usługi IoT Central i metadanych zabezpieczeń, a następnie połączenie ich ze zmodyfikowanymi wartościami w nowej treści w celu zaktualizowania aplikacji usługi IoT Central.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów, która zawiera aplikację usługi IoT Central.
resourceName	path	True	string	Nazwa zasobu usługi ARM aplikacji usługi IoT Central.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu.
sku	True	AppSkuInfo	Prawidłowa jednostka SKU wystąpienia.
identity		SystemAssignedServiceIdentity	Tożsamości zarządzane dla aplikacji usługi IoT Central.
properties.displayName		string	Nazwa wyświetlana aplikacji.
properties.subdomain		string	Poddomena aplikacji.
properties.template		string	Identyfikator szablonu aplikacji, który jest strategią definiującą cechy i zachowania aplikacji. Opcjonalne; jeśli nie zostanie określona, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	App	Jest to zwracane jako odpowiedź na żądanie sondowania stanu dla operacji tworzenia lub aktualizacji. Treść zawiera reprezentację zasobu, która wskazuje stan przejściowej aprowizacji.
201 Created	App	Jest to zwracane jako odpowiedź na żądanie sondowania stanu dla operacji tworzenia lub aktualizacji. Treść zawiera reprezentację zasobu, która wskazuje stan przejściowej aprowizacji.
202 Accepted		Zaakceptowane — żądanie umieszczenia zaakceptowane; operacja zostanie ukończona asynchronicznie.
Other Status Codes	CloudError	DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
App	Aplikacja usługi IoT Central.
AppSku	Nazwa jednostki SKU.
AppSkuInfo	Informacje o jednostce SKU aplikacji usługi IoT Central.
AppState	Bieżący stan aplikacji.
CloudError	Szczegóły błędu.
CloudErrorBody	Szczegóły odpowiedzi na błąd.
SystemAssignedServiceIdentity	Tożsamość usługi zarządzanej (przypisana przez system lub brak)
SystemAssignedServiceIdentityType	Typ tożsamości usługi zarządzanej (przypisany system lub brak).

App

Aplikacja usługi IoT Central.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu usługi ARM.
identity	SystemAssignedServiceIdentity	Tożsamości zarządzane dla aplikacji usługi IoT Central.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu usługi ARM.
properties.applicationId	string	Identyfikator aplikacji.
properties.displayName	string	Nazwa wyświetlana aplikacji.
properties.state	AppState	Bieżący stan aplikacji.
properties.subdomain	string	Poddomena aplikacji.
properties.template	string	Identyfikator szablonu aplikacji, który jest strategią definiującą cechy i zachowania aplikacji. Opcjonalne; jeśli nie zostanie określona, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw.
sku	AppSkuInfo	Prawidłowa jednostka SKU wystąpienia.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

AppSku

Nazwa jednostki SKU.

Nazwa	Typ	Opis
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informacje o jednostce SKU aplikacji usługi IoT Central.

Nazwa	Typ	Opis
name	AppSku	Nazwa jednostki SKU.

AppState

Bieżący stan aplikacji.

Nazwa	Typ	Opis
created	string
suspended	string

CloudError

Szczegóły błędu.

Nazwa	Typ	Opis
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy określonego błędu.

CloudErrorBody

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

SystemAssignedServiceIdentity

Tożsamość usługi zarządzanej (przypisana przez system lub brak)

Nazwa	Typ	Opis
principalId	string	Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId	string	Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type	SystemAssignedServiceIdentityType	Typ tożsamości usługi zarządzanej (przypisany system lub brak).

SystemAssignedServiceIdentityType

Typ tożsamości usługi zarządzanej (przypisany system lub brak).

Nazwa	Typ	Opis
None	string
SystemAssigned	string

Udostępnij za pośrednictwem