Apps - Get

Service:

IoT Central

API-versie:

2021-06-01

Haal de metagegevens van een IoT Central-toepassing op.

GET 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 naam van de ARM-resource van de IoT Central-toepassing.
subscriptionId	path	True	string	De abonnement-ID.
api-version	query	True	string	De versie van de API.

Antwoorden

Name	Type	Description
200 OK	App	De hoofdtekst bevat alle niet-beveiligingseigenschappen van de IoT Central-toepassing. Beveiligingsgerelateerde eigenschappen worden ingesteld op null.
Other Status Codes	CloudError	Standaardfoutreactie

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_Get

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.IoTCentral/iotApps/myIoTCentralApp?api-version=2021-06-01

Java

import com.azure.core.util.Context;

/** Samples for Apps GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_Get.json
     */
    /**
     * Sample code: Apps_Get.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsGet(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        manager.apps().getByResourceGroupWithResponse("resRg", "myIoTCentralApp", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.iotcentral import IotCentralClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iotcentral
# USAGE
    python apps_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IotCentralClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.apps.get(
        resource_group_name="resRg",
        resource_name="myIoTCentralApp",
    )
    print(response)


# x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armiotcentral_test

import (
	"context"
	"log"

	"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_Get.json
func ExampleAppsClient_Get() {
	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)
	}
	res, err := clientFactory.NewAppsClient().Get(ctx, "resRg", "myIoTCentralApp", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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"),
	// 		State: to.Ptr(armiotcentral.AppStateCreated),
	// 		Subdomain: to.Ptr("my-iot-central-app"),
	// 		Template: to.Ptr("iotc-pnp-preview@1.0.0"),
	// 	},
	// 	SKU: &armiotcentral.AppSKUInfo{
	// 		Name: to.Ptr(armiotcentral.AppSKU("F1")),
	// 	},
	// }
}

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

{
  "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",
    "subdomain": "my-iot-central-app",
    "template": "iotc-pnp-preview@1.0.0",
    "state": "created"
  },
  "sku": {
    "name": "F1"
  },
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
  }
}

Statuscode:

default

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

Definities

Name	Description
App	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 foutreactie.
SystemAssignedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen of geen)
SystemAssignedServiceIdentityType	Type beheerde service-identiteit (door het systeem toegewezen of geen).

App

Object

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 pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$	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. Facultatief; 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.

AppSku

Inventarisatie

De naam van de SKU.

Waarde	Description
ST0
ST1
ST2

AppSkuInfo

Object

Informatie over de SKU van de IoT Central-toepassing.

Name	Type	Description
name	AppSku	De naam van de SKU.

AppState

Inventarisatie

De huidige status van de toepassing.

Waarde	Description
created
suspended

CloudError

Object

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

Object

Details van 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

Object

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

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

SystemAssignedServiceIdentityType

Inventarisatie

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

Waarde	Description
None
SystemAssigned