Apps - Update

Referência

Serviço:: IoT Central

Versão da API:: 2021-06-01

Atualize os metadados de uma aplicação do IoT Central.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém a aplicação do IoT Central.
resourceName	path	True	string	O nome do recurso arm da aplicação do IoT Central.
subscriptionId	path	True	string	O identificador da subscrição.
api-version	query	True	string	A versão da API.

Corpo do Pedido

Name	Tipo	Description
identity	SystemAssignedServiceIdentity	As identidades geridas da aplicação do IoT Central.
properties.displayName	string	O nome a apresentar da aplicação.
properties.subdomain	string	O subdomínio da aplicação.
properties.template	string	O ID do modelo de aplicação, que é um esquema que define as características e os comportamentos de uma aplicação. Opcional; se não for especificado, a predefinição é um esquema em branco e permite que a aplicação seja definida de raiz.
sku	AppSkuInfo	Um SKU de instância válido.
tags	object	Etiquetas de instância

Respostas

Name	Tipo	Description
200 OK	App	Isto é devolvido como resposta ao pedido de consulta de estado para a operação de criação ou atualização. O corpo contém a representação de recursos que indica um estado de aprovisionamento transitório.
202 Accepted		Aceite - Colocar o pedido aceite; a operação será concluída de forma assíncrona.
Other Status Codes	CloudError	DefaultErrorResponse

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Apps_Update

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 202

Código de estado:: default

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

Definições

Name	Description
App	A aplicação do IoT Central.
AppPatch	A descrição da aplicação do IoT Central.
AppSku	O nome do SKU.
AppSkuInfo	Informações sobre o SKU da aplicação IoT Central.
AppState	O estado atual da aplicação.
CloudError	Detalhes do erro.
CloudErrorBody	Detalhes da resposta ao erro.
SystemAssignedServiceIdentity	Identidade de serviço gerida (ou sistema atribuído ou nenhum)
SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerida (ou sistema atribuído ou nenhum).

App

A aplicação do IoT Central.

Name	Tipo	Description
id	string	O identificador de recurso do ARM.
identity	SystemAssignedServiceIdentity	As identidades geridas da aplicação do IoT Central.
location	string	A localização do recurso.
name	string	O nome do recurso do ARM.
properties.applicationId	string	O ID da aplicação.
properties.displayName	string	O nome a apresentar da aplicação.
properties.state	AppState	O estado atual da aplicação.
properties.subdomain	string	O subdomínio da aplicação.
properties.template	string	O ID do modelo de aplicação, que é um esquema que define as características e os comportamentos de uma aplicação. Opcional; se não for especificado, a predefinição é um esquema em branco e permite que a aplicação seja definida de raiz.
sku	AppSkuInfo	Um SKU de instância válido.
tags	object	As etiquetas de recursos.
type	string	O tipo de recurso.

AppPatch

A descrição da aplicação do IoT Central.

Name	Tipo	Description
identity	SystemAssignedServiceIdentity	As identidades geridas da aplicação do IoT Central.
properties.applicationId	string	O ID da aplicação.
properties.displayName	string	O nome a apresentar da aplicação.
properties.state	AppState	O estado atual da aplicação.
properties.subdomain	string	O subdomínio da aplicação.
properties.template	string	O ID do modelo de aplicação, que é um esquema que define as características e os comportamentos de uma aplicação. Opcional; se não for especificado, a predefinição é um esquema em branco e permite que a aplicação seja definida de raiz.
sku	AppSkuInfo	Um SKU de instância válido.
tags	object	Etiquetas de instância

AppSku

O nome do SKU.

Name	Tipo	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informações sobre o SKU da aplicação IoT Central.

Name	Tipo	Description
name	AppSku	O nome do SKU.

AppState

O estado atual da aplicação.

Name	Tipo	Description
created	string
suspended	string

CloudError

Detalhes do erro.

Name	Tipo	Description
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro específico.

CloudErrorBody

Detalhes da resposta ao erro.

Name	Tipo	Description
code	string	O código de erro.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

SystemAssignedServiceIdentity

Identidade de serviço gerida (ou sistema atribuído ou nenhum)

Name	Tipo	Description
principalId	string	O ID do principal de serviço da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	O ID de inquilino da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerida (ou sistema atribuído ou nenhum).

SystemAssignedServiceIdentityType

Tipo de identidade de serviço gerida (ou sistema atribuído ou nenhum).

Name	Tipo	Description
None	string
SystemAssigned	string

Partilhar via