Apps - Update

Referência

Serviço:: IoT Central

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

Atualize os metadados de um aplicativo do IoT Central.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o aplicativo IoT Central.
resourceName	path	True	string	O nome do recurso ARM do aplicativo IoT Central.
subscriptionId	path	True	string	O identificador da assinatura.
api-version	query	True	string	A versão da API.

Corpo da solicitação

Nome	Tipo	Description
identity	SystemAssignedServiceIdentity	As identidades gerenciadas para o aplicativo IoT Central.
properties.displayName	string	O nome de exibição do aplicativo.
properties.subdomain	string	O subdomínio do aplicativo.
properties.template	string	A ID do modelo de aplicativo, que é um blueprint que define as características e os comportamentos de um aplicativo. Opcional; se não for especificado, o padrão será um blueprint em branco e permitirá que o aplicativo seja definido do zero.
sku	AppSkuInfo	Um SKU de instância válido.
tags	object	Marcas de instância

Respostas

Nome	Tipo	Description
200 OK	App	Isso é retornado como uma resposta ao status solicitação de sondagem para a operação de criação ou atualização. O corpo contém a representação de recurso que indica um estado de provisionamento transitório.
202 Accepted		Aceito – Solicitação put aceita; a operação será concluída de forma assíncrona.
Other Status Codes	CloudError	DefaultErrorResponse

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Apps_Update

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 202

Código de status:: default

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

Definições

Nome	Description
App	O aplicativo do IoT Central.
AppPatch	A descrição do aplicativo IoT Central.
AppSku	O nome da SKU.
AppSkuInfo	Informações sobre a SKU do aplicativo IoT Central.
AppState	O estado atual do aplicativo.
CloudError	Detalhes do erro.
CloudErrorBody	Detalhes da resposta de erro.
SystemAssignedServiceIdentity	Identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma)
SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma).

App

O aplicativo do IoT Central.

Nome	Tipo	Description
id	string	O identificador de recurso do ARM.
identity	SystemAssignedServiceIdentity	As identidades gerenciadas para o aplicativo IoT Central.
location	string	O local do recurso.
name	string	O nome do recurso arm.
properties.applicationId	string	A ID do aplicativo.
properties.displayName	string	O nome de exibição do aplicativo.
properties.state	AppState	O estado atual do aplicativo.
properties.subdomain	string	O subdomínio do aplicativo.
properties.template	string	A ID do modelo de aplicativo, que é um blueprint que define as características e os comportamentos de um aplicativo. Opcional; se não for especificado, o padrão será um blueprint em branco e permitirá que o aplicativo seja definido do zero.
sku	AppSkuInfo	Um SKU de instância válido.
tags	object	As marcas do recurso.
type	string	O tipo de recurso.

AppPatch

A descrição do aplicativo IoT Central.

Nome	Tipo	Description
identity	SystemAssignedServiceIdentity	As identidades gerenciadas para o aplicativo IoT Central.
properties.applicationId	string	A ID do aplicativo.
properties.displayName	string	O nome de exibição do aplicativo.
properties.state	AppState	O estado atual do aplicativo.
properties.subdomain	string	O subdomínio do aplicativo.
properties.template	string	A ID do modelo de aplicativo, que é um blueprint que define as características e os comportamentos de um aplicativo. Opcional; se não for especificado, o padrão será um blueprint em branco e permitirá que o aplicativo seja definido do zero.
sku	AppSkuInfo	Um SKU de instância válido.
tags	object	Marcas de instância

AppSku

O nome da SKU.

Nome	Tipo	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informações sobre a SKU do aplicativo IoT Central.

Nome	Tipo	Description
name	AppSku	O nome da SKU.

AppState

O estado atual do aplicativo.

Nome	Tipo	Description
created	string
suspended	string

CloudError

Detalhes do erro.

Nome	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 de erro.

Nome	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 gerenciada (atribuída pelo sistema ou nenhuma)

Nome	Tipo	Description
principalId	string	A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	A ID do locatário da identidade atribuída pelo sistema. Essa propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma).

SystemAssignedServiceIdentityType

Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma).

Nome	Tipo	Description
None	string
SystemAssigned	string

Compartilhar via