Apps - Get

Referenz

Dienst:: IoT Central

API-Version:: 2021-06-01

Rufen Sie die Metadaten einer IoT Central-Anwendung ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die IoT Central-Anwendung enthält.
resourceName	path	True	string	Der ARM-Ressourcenname der IoT Central-Anwendung.
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die Version der API.

Antworten

Name	Typ	Beschreibung
200 OK	App	Der Text enthält alle nicht sicherheitsrelevanten Eigenschaften der IoT Central-Anwendung. Sicherheitsbezogene Eigenschaften werden auf NULL festgelegt.
Other Status Codes	CloudError	Standardfehlerantwort

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Apps_Get

Beispielanforderung

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

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

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

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
App	Die IoT Central-Anwendung.
AppSku	Der Name der SKU.
AppSkuInfo	Informationen zur SKU der IoT Central-Anwendung.
AppState	Der aktuelle Status der Anwendung.
CloudError	Fehlerdetails.
CloudErrorBody	Details zur Fehlerantwort.
SystemAssignedServiceIdentity	Identität des verwalteten Diensts (entweder vom System zugewiesen oder ohne)
SystemAssignedServiceIdentityType	Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne).

App

Objekt

Die IoT Central-Anwendung.

Name	Typ	Beschreibung
id	string	Der ARM-Ressourcenbezeichner.
identity	SystemAssignedServiceIdentity	Die verwalteten Identitäten für die IoT Central-Anwendung.
location	string	Der Ressourcenspeicherort.
name	string pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$	Der ARM-Ressourcenname.
properties.applicationId	string	Die ID der Anwendung.
properties.displayName	string	Der Anzeigename der Anwendung.
properties.state	AppState	Der aktuelle Status der Anwendung.
properties.subdomain	string	Die Unterdomäne der Anwendung.
properties.template	string	Die ID der Anwendungsvorlage, bei der es sich um einen Blueprint handelt, der die Merkmale und Verhaltensweisen einer Anwendung definiert. Wahlfrei; wenn nicht angegeben, wird standardmäßig ein leerer Blueprint verwendet, und die Anwendung kann von Grund auf neu definiert werden.
sku	AppSkuInfo	Eine gültige Instanz-SKU.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

AppSku

Enumeration

Der Name der SKU.

Wert	Beschreibung
ST0
ST1
ST2

AppSkuInfo

Objekt

Informationen zur SKU der IoT Central-Anwendung.

Name	Typ	Beschreibung
name	AppSku	Der Name der SKU.

AppState

Enumeration

Der aktuelle Status der Anwendung.

Wert	Beschreibung
created
suspended

CloudError

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
error.code	string	Der Fehlercode.
error.details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
error.message	string	Die Fehlermeldung.
error.target	string	Das Ziel des bestimmten Fehlers.

CloudErrorBody

Objekt

Details zur Fehlerantwort.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

SystemAssignedServiceIdentity

Objekt

Identität des verwalteten Diensts (entweder vom System zugewiesen oder ohne)

Name	Typ	Beschreibung
principalId	string (uuid)	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string (uuid)	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	SystemAssignedServiceIdentityType	Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne).

SystemAssignedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität (entweder vom System zugewiesen oder ohne).

Wert	Beschreibung
None
SystemAssigned

Freigeben über

Apps - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Apps_Get

Beispielanforderung

Beispiel für eine Antwort

Definitionen

App

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Zusätzliche Ressourcen