Apps - Update

Odwołanie

Usługa:: IoT Central

Wersja interfejsu API:: 2021-06-01

Aktualizowanie metadanych aplikacji usługi IoT Central.

PATCH 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	Typ	Opis
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ą, która definiuje cechy i zachowania aplikacji. Fakultatywny; jeśli nie zostanie określony, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw.
sku	AppSkuInfo	Prawidłowa jednostka SKU wystąpienia.
tags	object	Tagi wystąpienia

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.
202 Accepted		Zaakceptowane — zaakceptuj żądanie; operacja zostanie ukończona asynchronicznie.
Other Status Codes	CloudError	DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Apps_Update

Przykładowe żądanie

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

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 202

Kod stanu:: default

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

Definicje

Nazwa	Opis
App	Aplikacja usługi IoT Central.
AppPatch	Opis aplikacji 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

Objekt

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 pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$	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ą, która definiuje cechy i zachowania aplikacji. Fakultatywny; jeśli nie zostanie określony, 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.

AppPatch

Objekt

Opis aplikacji usługi IoT Central.

Nazwa	Typ	Opis
identity	SystemAssignedServiceIdentity	Tożsamości zarządzane dla aplikacji usługi IoT Central.
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ą, która definiuje cechy i zachowania aplikacji. Fakultatywny; jeśli nie zostanie określony, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw.
sku	AppSkuInfo	Prawidłowa jednostka SKU wystąpienia.
tags	object	Tagi wystąpienia

AppSku

Wyliczanie

Nazwa jednostki SKU.

Wartość	Opis
ST0
ST1
ST2

AppSkuInfo

Objekt

Informacje o jednostce SKU aplikacji usługi IoT Central.

Nazwa	Typ	Opis
name	AppSku	Nazwa jednostki SKU.

AppState

Wyliczanie

Bieżący stan aplikacji.

Wartość	Opis
created
suspended

CloudError

Objekt

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

Objekt

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

Objekt

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

Nazwa	Typ	Opis
principalId	string (uuid)	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 (uuid)	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

Wyliczanie

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

Wartość	Opis
None
SystemAssigned

Udostępnij za pośrednictwem

Apps - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Apps_Update

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

App

AppPatch

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Dodatkowe zasoby