Apps - Get

Reference

Service:: IoT Central

API Version:: 2021-06-01

Získejte metadata aplikace IoT Central.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje aplikaci IoT Central.
resourceName	path	True	string	Název prostředku ARM aplikace IoT Central.
subscriptionId	path	True	string	Identifikátor předplatného.
api-version	query	True	string	Verze rozhraní API

Odpovědi

Name	Typ	Description
200 OK	App	Tělo obsahuje všechny vlastnosti aplikace IoT Central, které se netýknou zabezpečení. Vlastnosti související se zabezpečením jsou nastaveny na hodnotu null.
Other Status Codes	CloudError	Výchozí chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Apps_Get

Sample Request

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

Sample Response

Status code:: 200

code: 200

Response Body

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

Status code:: default

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

Definice

Name	Description
App	Aplikace IoT Central.
AppSku	Název skladové položky.
AppSkuInfo	Informace o skladové pouce aplikace IoT Central
AppState	Aktuální stav aplikace.
CloudError	Podrobnosti o chybě.
CloudErrorBody	Podrobnosti o odpovědi na chybu
SystemAssignedServiceIdentity	Identita spravované služby (přiřazená systémem nebo žádná)
SystemAssignedServiceIdentityType	Typ identity spravované služby (buď přiřazený systémem, nebo žádný).

App

Aplikace IoT Central.

Name	Typ	Description
id	string	Identifikátor prostředku ARM.
identity	SystemAssignedServiceIdentity	Spravované identity pro aplikaci IoT Central.
location	string	Umístění prostředku.
name	string	Název prostředku ARM.
properties.applicationId	string	ID aplikace.
properties.displayName	string	Zobrazovaný název aplikace.
properties.state	AppState	Aktuální stav aplikace.
properties.subdomain	string	Subdoména aplikace.
properties.template	string	ID šablony aplikace, což je podrobný plán, který definuje charakteristiky a chování aplikace. Volitelné; Pokud není zadaný, ve výchozím nastavení se použije prázdný podrobný plán a umožňuje definovat aplikaci úplně od začátku.
sku	AppSkuInfo	Platná skladová položka instance.
tags	object	Značky prostředků.
type	string	Typ prostředku.

AppSku

Název skladové položky.

Name	Typ	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informace o skladové pouce aplikace IoT Central

Name	Typ	Description
name	AppSku	Název skladové položky.

AppState

Aktuální stav aplikace.

Name	Typ	Description
created	string
suspended	string

CloudError

Podrobnosti o chybě.

Name	Typ	Description
error.code	string	Kód chyby
error.details	CloudErrorBody[]	Seznam dalších podrobností o chybě
error.message	string	Chybová zpráva
error.target	string	Cíl konkrétní chyby.

CloudErrorBody

Podrobnosti o odpovědi na chybu

Name	Typ	Description
code	string	Kód chyby
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Chybová zpráva
target	string	Cíl konkrétní chyby.

SystemAssignedServiceIdentity

Identita spravované služby (přiřazená systémem nebo žádná)

Name	Typ	Description
principalId	string	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
type	SystemAssignedServiceIdentityType	Typ identity spravované služby (buď přiřazený systémem, nebo žádný).

SystemAssignedServiceIdentityType

Typ identity spravované služby (buď přiřazený systémem, nebo žádný).

Name	Typ	Description
None	string
SystemAssigned	string

Apps - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Apps_Get

Sample Request

Sample Response

Definice

App

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Další materiály