Apps - Update

Referentie

Service:: IoT Central

API-versie:: 2021-06-01

Werk de metagegevens van een IoT Central-toepassing bij.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de IoT Central-toepassing bevat.
resourceName	path	True	string	De ARM-resourcenaam van de IoT Central-toepassing.
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De versie van de API.

Aanvraagbody

Name	Type	Description
identity	SystemAssignedServiceIdentity	De beheerde identiteiten voor de IoT Central-toepassing.
properties.displayName	string	De weergavenaam van de toepassing.
properties.subdomain	string	Het subdomein van de toepassing.
properties.template	string	De id van de toepassingssjabloon, een blauwdruk die de kenmerken en het gedrag van een toepassing definieert. Optionele; als dit niet is opgegeven, wordt standaard een lege blauwdruk gebruikt en kan de toepassing helemaal opnieuw worden gedefinieerd.
sku	AppSkuInfo	Een geldige exemplaar-SKU.
tags	object	Exemplaartags

Antwoorden

Name	Type	Description
200 OK	App	Dit wordt geretourneerd als reactie op de aanvraag voor status polling voor de bewerking voor maken of bijwerken. De hoofdtekst bevat de resourceweergave die een overgangsinrichtingsstatus aangeeft.
202 Accepted		Geaccepteerd - Aanvraag geaccepteerd plaatsen; de bewerking asynchroon wordt voltooid.
Other Status Codes	CloudError	DefaultErrorResponse

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Apps_Update

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
App	De IoT Central-toepassing.
AppPatch	De beschrijving van de IoT Central-toepassing.
AppSku	De naam van de SKU.
AppSkuInfo	Informatie over de SKU van de IoT Central-toepassing.
AppState	De huidige status van de toepassing.
CloudError	Foutdetails.
CloudErrorBody	Details van de foutreactie.
SystemAssignedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen of geen)
SystemAssignedServiceIdentityType	Type beheerde service-identiteit (door het systeem toegewezen of geen).

App

De IoT Central-toepassing.

Name	Type	Description
id	string	De ARM-resource-id.
identity	SystemAssignedServiceIdentity	De beheerde identiteiten voor de IoT Central-toepassing.
location	string	De resourcelocatie.
name	string	De naam van de ARM-resource.
properties.applicationId	string	De id van de toepassing.
properties.displayName	string	De weergavenaam van de toepassing.
properties.state	AppState	De huidige status van de toepassing.
properties.subdomain	string	Het subdomein van de toepassing.
properties.template	string	De id van de toepassingssjabloon, een blauwdruk die de kenmerken en het gedrag van een toepassing definieert. Optionele; als dit niet is opgegeven, wordt standaard een lege blauwdruk gebruikt en kan de toepassing helemaal opnieuw worden gedefinieerd.
sku	AppSkuInfo	Een geldige exemplaar-SKU.
tags	object	De resourcetags.
type	string	Het resourcetype.

AppPatch

De beschrijving van de IoT Central-toepassing.

Name	Type	Description
identity	SystemAssignedServiceIdentity	De beheerde identiteiten voor de IoT Central-toepassing.
properties.applicationId	string	De id van de toepassing.
properties.displayName	string	De weergavenaam van de toepassing.
properties.state	AppState	De huidige status van de toepassing.
properties.subdomain	string	Het subdomein van de toepassing.
properties.template	string	De id van de toepassingssjabloon, een blauwdruk die de kenmerken en het gedrag van een toepassing definieert. Optionele; als dit niet is opgegeven, wordt standaard een lege blauwdruk gebruikt en kan de toepassing helemaal opnieuw worden gedefinieerd.
sku	AppSkuInfo	Een geldige exemplaar-SKU.
tags	object	Exemplaartags

AppSku

De naam van de SKU.

Name	Type	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informatie over de SKU van de IoT Central-toepassing.

Name	Type	Description
name	AppSku	De naam van de SKU.

AppState

De huidige status van de toepassing.

Name	Type	Description
created	string
suspended	string

CloudError

Foutdetails.

Name	Type	Description
error.code	string	De foutcode.
error.details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
error.message	string	Het foutbericht.
error.target	string	Het doel van de specifieke fout.

CloudErrorBody

Details van de foutreactie.

Name	Type	Description
code	string	De foutcode.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

SystemAssignedServiceIdentity

Beheerde service-identiteit (door het systeem toegewezen of geen)

Name	Type	Description
principalId	string	De service-principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
tenantId	string	De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
type	SystemAssignedServiceIdentityType	Type beheerde service-identiteit (door het systeem toegewezen of geen).

SystemAssignedServiceIdentityType

Type beheerde service-identiteit (door het systeem toegewezen of geen).

Name	Type	Description
None	string
SystemAssigned	string

Delen via