Apps - Update

Referenz

Dienst:: IoT Central

API-Version:: 2021-06-01

Aktualisieren Sie die Metadaten einer IoT Central-Anwendung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die IoT Central-Anwendung enthält.
resourceName	path	True	string	Der ARM-Ressourcenname der IoT Central-Anwendung.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Anforderungstext

Name	Typ	Beschreibung
identity	SystemAssignedServiceIdentity	Die verwalteten Identitäten für die IoT Central-Anwendung.
properties.displayName	string	Der Anzeigename der Anwendung.
properties.subdomain	string	Die Unterdomäne der Anwendung.
properties.template	string	Die ID der Anwendungsvorlage, bei der es sich um eine Blaupause handelt, die die Merkmale und Das Verhalten einer Anwendung definiert. Optional; wenn nicht angegeben, wird standardmäßig eine leere Blaupause verwendet, und die Anwendung kann von Grund auf neu definiert werden.
sku	AppSkuInfo	Eine gültige instance-SKU.
tags	object	Instanztags

Antworten

Name	Typ	Beschreibung
200 OK	App	Dies wird als Antwort auf die status Abrufanforderung für den Erstellungs- oder Aktualisierungsvorgang zurückgegeben. Der Text enthält die Ressourcendarstellung, die einen Übergangsbereitstellungsstatus angibt.
202 Accepted		Akzeptiert: Put-Anforderung akzeptiert; Der Vorgang wird asynchron abgeschlossen.
Other Status Codes	CloudError	DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Apps_Update

Beispielanforderung

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

Beispiel für eine Antwort

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

Statuscode:: 202

Statuscode:: default

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

Definitionen

Name	Beschreibung
App	Die IoT Central-Anwendung.
AppPatch	Die Beschreibung der IoT Central-Anwendung.
AppSku	Der Name der SKU.
AppSkuInfo	Informationen zur SKU der IoT Central-Anwendung.
AppState	Der aktuelle Status der Anwendung.
CloudError	Fehlerdetails.
CloudErrorBody	Details zur Fehlerantwort.
SystemAssignedServiceIdentity	Verwaltete Dienstidentität (entweder systemseitig zugewiesen oder keine)
SystemAssignedServiceIdentityType	Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne).

App

Die IoT Central-Anwendung.

Name	Typ	Beschreibung
id	string	Der ARM-Ressourcenbezeichner.
identity	SystemAssignedServiceIdentity	Die verwalteten Identitäten für die IoT Central-Anwendung.
location	string	Der Ressourcenspeicherort.
name	string	Der NAME der ARM-Ressource.
properties.applicationId	string	Die ID der Anwendung.
properties.displayName	string	Der Anzeigename der Anwendung.
properties.state	AppState	Der aktuelle Status der Anwendung.
properties.subdomain	string	Die Unterdomäne der Anwendung.
properties.template	string	Die ID der Anwendungsvorlage, bei der es sich um eine Blaupause handelt, die die Merkmale und Das Verhalten einer Anwendung definiert. Optional; wenn nicht angegeben, wird standardmäßig eine leere Blaupause verwendet, und die Anwendung kann von Grund auf neu definiert werden.
sku	AppSkuInfo	Eine gültige instance-SKU.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

AppPatch

Die Beschreibung der IoT Central-Anwendung.

Name	Typ	Beschreibung
identity	SystemAssignedServiceIdentity	Die verwalteten Identitäten für die IoT Central-Anwendung.
properties.applicationId	string	Die ID der Anwendung.
properties.displayName	string	Der Anzeigename der Anwendung.
properties.state	AppState	Der aktuelle Status der Anwendung.
properties.subdomain	string	Die Unterdomäne der Anwendung.
properties.template	string	Die ID der Anwendungsvorlage, bei der es sich um eine Blaupause handelt, die die Merkmale und Das Verhalten einer Anwendung definiert. Optional; wenn nicht angegeben, wird standardmäßig eine leere Blaupause verwendet, und die Anwendung kann von Grund auf neu definiert werden.
sku	AppSkuInfo	Eine gültige instance-SKU.
tags	object	Instanztags

AppSku

Der Name der SKU.

Name	Typ	Beschreibung
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informationen zur SKU der IoT Central-Anwendung.

Name	Typ	Beschreibung
name	AppSku	Der Name der SKU.

AppState

Der aktuelle Status der Anwendung.

Name	Typ	Beschreibung
created	string
suspended	string

CloudError

Fehlerdetails.

Name	Typ	Beschreibung
error.code	string	Der Fehlercode.
error.details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
error.message	string	Die Fehlermeldung.
error.target	string	Das Ziel des bestimmten Fehlers.

CloudErrorBody

Details zur Fehlerantwort.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

SystemAssignedServiceIdentity

Verwaltete Dienstidentität (entweder systemseitig zugewiesen oder keine)

Name	Typ	Beschreibung
principalId	string	Die Dienstprinzipal-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der systemseitig zugewiesenen Identität. Diese Eigenschaft wird nur für eine systemseitig zugewiesene Identität bereitgestellt.
type	SystemAssignedServiceIdentityType	Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne).

SystemAssignedServiceIdentityType

Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne).

Name	Typ	Beschreibung
None	string
SystemAssigned	string

Freigeben über