Apps - Create Or Update

Başvuru

Hizmet:: IoT Central

API Sürümü:: 2021-06-01

IoT Central uygulamasının meta verilerini oluşturun veya güncelleştirin. Bir özelliği değiştirmek için her zamanki düzen, IoT Central uygulama meta verilerini ve güvenlik meta verilerini almak ve bunları yeni bir gövdedeki değiştirilmiş değerlerle birleştirerek IoT Central uygulamasını güncelleştirmektir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	IoT Central uygulamasını içeren kaynak grubunun adı.
resourceName	path	True	string	IoT Central uygulamasının ARM kaynak adı.
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
api-version	query	True	string	API'nin sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Kaynak konumu.
sku	True	AppSkuInfo	Geçerli bir örnek SKU'su.
identity		SystemAssignedServiceIdentity	IoT Central uygulaması için yönetilen kimlikler.
properties.displayName		string	Uygulamanın görünen adı.
properties.subdomain		string	Uygulamanın alt etki alanı.
properties.template		string	Bir uygulamanın özelliklerini ve davranışlarını tanımlayan bir şema olan uygulama şablonunun kimliği. Isteğe bağlı; belirtilmezse, varsayılan olarak boş bir şemaya ayarlanır ve uygulamanın sıfırdan tanımlanmasına izin verir.
tags		object	Kaynak etiketleri.

Yanıtlar

Name	Tür	Description
200 OK	App	Bu, oluşturma veya güncelleştirme işlemi için durum yoklama isteğine yanıt olarak döndürülür. Gövde, geçişli sağlama durumunu gösteren kaynak gösterimini içerir.
201 Created	App	Bu, oluşturma veya güncelleştirme işlemi için durum yoklama isteğine yanıt olarak döndürülür. Gövde, geçişli sağlama durumunu gösteren kaynak gösterimini içerir.
202 Accepted		Kabul Edildi - İstek kabul edildi; işlemi zaman uyumsuz olarak tamamlanır.
Other Status Codes	CloudError	DefaultErrorResponse

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Apps_CreateOrUpdate

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Durum kodu:: 201

code: 201
message: Created
target: ResourceHandler.ExecutePutRequest

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

Durum kodu:: 202

Durum kodu:: default

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

Tanımlar

Name	Description
App	IoT Central uygulaması.
AppSku	SKU'nun adı.
AppSkuInfo	IoT Central uygulamasının SKU'su hakkında bilgi.
AppState	Uygulamanın geçerli durumu.
CloudError	Hata ayrıntıları.
CloudErrorBody	Hata yanıtının ayrıntıları.
SystemAssignedServiceIdentity	Yönetilen hizmet kimliği (sistem tarafından atanmış veya yok)
SystemAssignedServiceIdentityType	Yönetilen hizmet kimliğinin türü (sistem tarafından atanmış veya yok).

App

IoT Central uygulaması.

Name	Tür	Description
id	string	ARM kaynak tanımlayıcısı.
identity	SystemAssignedServiceIdentity	IoT Central uygulaması için yönetilen kimlikler.
location	string	Kaynak konumu.
name	string	ARM kaynak adı.
properties.applicationId	string	Uygulamanın kimliği.
properties.displayName	string	Uygulamanın görünen adı.
properties.state	AppState	Uygulamanın geçerli durumu.
properties.subdomain	string	Uygulamanın alt etki alanı.
properties.template	string	Bir uygulamanın özelliklerini ve davranışlarını tanımlayan bir şema olan uygulama şablonunun kimliği. Isteğe bağlı; belirtilmezse, varsayılan olarak boş bir şemaya ayarlanır ve uygulamanın sıfırdan tanımlanmasına izin verir.
sku	AppSkuInfo	Geçerli bir örnek SKU'su.
tags	object	Kaynak etiketleri.
type	string	Kaynak türü.

AppSku

SKU'nun adı.

Name	Tür	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

IoT Central uygulamasının SKU'su hakkında bilgi.

Name	Tür	Description
name	AppSku	SKU'nun adı.

AppState

Uygulamanın geçerli durumu.

Name	Tür	Description
created	string
suspended	string

CloudError

Hata ayrıntıları.

Name	Tür	Description
error.code	string	Hata kodu.
error.details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
error.message	string	Hata iletisi.
error.target	string	Belirli bir hatanın hedefi.

CloudErrorBody

Hata yanıtının ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

SystemAssignedServiceIdentity

Yönetilen hizmet kimliği (sistem tarafından atanmış veya yok)

Name	Tür	Description
principalId	string	Sistem tarafından atanan kimliğin hizmet sorumlusu kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
tenantId	string	Sistem tarafından atanan kimliğin kiracı kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
type	SystemAssignedServiceIdentityType	Yönetilen hizmet kimliğinin türü (sistem tarafından atanmış veya yok).

SystemAssignedServiceIdentityType

Yönetilen hizmet kimliğinin türü (sistem tarafından atanmış veya yok).

Name	Tür	Description
None	string
SystemAssigned	string

Aracılığıyla paylaş