Apps - Update

Referencia

Servicio:: IoT Central

Versión de la API:: 2021-06-01

Actualice los metadatos de una aplicación de IoT Central.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene la aplicación de IoT Central.
resourceName	path	True	string	Nombre del recurso de ARM de la aplicación de IoT Central.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	Versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	SystemAssignedServiceIdentity	Identidades administradas para la aplicación de IoT Central.
properties.displayName	string	Nombre para mostrar de la aplicación.
properties.subdomain	string	Subdominio de la aplicación.
properties.template	string	Identificador de la plantilla de aplicación, que es un plano técnico que define las características y comportamientos de una aplicación. Opcional; si no se especifica, el valor predeterminado es un plano técnico en blanco y permite definir la aplicación desde cero.
sku	AppSkuInfo	Una SKU de instancia válida.
tags	object	Etiquetas de instancia

Respuestas

Nombre	Tipo	Description
200 OK	App	Esto se devuelve como respuesta a la solicitud de sondeo de estado para la operación de creación o actualización. El cuerpo contiene la representación del recurso que indica un estado de aprovisionamiento transitorio.
202 Accepted		Aceptado : se ha aceptado la solicitud put; la operación se completará de forma asincrónica.
Other Status Codes	CloudError	DefaultErrorResponse

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Apps_Update

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

status code:: 202

status code:: default

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

Definiciones

Nombre	Description
App	La aplicación de IoT Central.
AppPatch	Descripción de la aplicación de IoT Central.
AppSku	Nombre de la SKU.
AppSkuInfo	Información sobre la SKU de la aplicación de IoT Central.
AppState	Estado actual de la aplicación.
CloudError	Detalles del error.
CloudErrorBody	Detalles de la respuesta de error.
SystemAssignedServiceIdentity	Identidad de servicio administrada (asignada por el sistema o ninguna)
SystemAssignedServiceIdentityType	Tipo de identidad de servicio administrada (asignada por el sistema o ninguna).

App

Object

La aplicación de IoT Central.

Nombre	Tipo	Description
id	string	Identificador de recursos de ARM.
identity	SystemAssignedServiceIdentity	Identidades administradas para la aplicación de IoT Central.
location	string	Ubicación del recurso.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$	Nombre del recurso de ARM.
properties.applicationId	string	Identificador de la aplicación.
properties.displayName	string	Nombre para mostrar de la aplicación.
properties.state	AppState	Estado actual de la aplicación.
properties.subdomain	string	Subdominio de la aplicación.
properties.template	string	Identificador de la plantilla de aplicación, que es un plano técnico que define las características y comportamientos de una aplicación. Opcional; si no se especifica, el valor predeterminado es un plano técnico en blanco y permite definir la aplicación desde cero.
sku	AppSkuInfo	Una SKU de instancia válida.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

AppPatch

Object

Descripción de la aplicación de IoT Central.

Nombre	Tipo	Description
identity	SystemAssignedServiceIdentity	Identidades administradas para la aplicación de IoT Central.
properties.applicationId	string	Identificador de la aplicación.
properties.displayName	string	Nombre para mostrar de la aplicación.
properties.state	AppState	Estado actual de la aplicación.
properties.subdomain	string	Subdominio de la aplicación.
properties.template	string	Identificador de la plantilla de aplicación, que es un plano técnico que define las características y comportamientos de una aplicación. Opcional; si no se especifica, el valor predeterminado es un plano técnico en blanco y permite definir la aplicación desde cero.
sku	AppSkuInfo	Una SKU de instancia válida.
tags	object	Etiquetas de instancia

AppSku

Enumeración

Nombre de la SKU.

Valor	Description
ST0
ST1
ST2

AppSkuInfo

Object

Información sobre la SKU de la aplicación de IoT Central.

Nombre	Tipo	Description
name	AppSku	Nombre de la SKU.

AppState

Enumeración

Estado actual de la aplicación.

Valor	Description
created
suspended

CloudError

Object

Detalles del error.

Nombre	Tipo	Description
error.code	string	Código de error.
error.details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
error.message	string	Mensaje de error.
error.target	string	Destino del error concreto.

CloudErrorBody

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
code	string	Código de error.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

SystemAssignedServiceIdentity

Object

Identidad de servicio administrada (asignada por el sistema o ninguna)

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	SystemAssignedServiceIdentityType	Tipo de identidad de servicio administrada (asignada por el sistema o ninguna).

SystemAssignedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (asignada por el sistema o ninguna).

Valor	Description
None
SystemAssigned

Compartir a través de

Apps - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Apps_Update

Solicitud de ejemplo

Respuesta de muestra

Definiciones

App

AppPatch

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Recursos adicionales