Apps - Get

Referencia

Service:: IoT Central

API Version:: 2021-06-01

Lekérheti egy IoT Central-alkalmazás metaadatait.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az IoT Central-alkalmazást tartalmazó erőforráscsoport neve.
resourceName	path	True	string	Az IoT Central-alkalmazás ARM-erőforrásneve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Válaszok

Name	Típus	Description
200 OK	App	A törzs tartalmazza az IoT Central-alkalmazás összes nem biztonsági tulajdonságát. A biztonsággal kapcsolatos tulajdonságok null értékre vannak állítva.
Other Status Codes	CloudError	Alapértelmezett hibaválasz

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
App	Az IoT Central-alkalmazás.
AppSku	A termékváltozat neve.
AppSkuInfo	Az IoT Central-alkalmazás termékváltozatával kapcsolatos információk.
AppState	Az alkalmazás aktuális állapota.
CloudError	Hiba részletei.
CloudErrorBody	A hibaválasz részletei.
SystemAssignedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt vagy nincs)
SystemAssignedServiceIdentityType	A felügyeltszolgáltatás-identitás típusa (rendszer által hozzárendelt vagy egyik sem).

App

Az IoT Central-alkalmazás.

Name	Típus	Description
id	string	Az ARM-erőforrás azonosítója.
identity	SystemAssignedServiceIdentity	Az IoT Central-alkalmazás felügyelt identitásai.
location	string	Az erőforrás helye.
name	string	Az ARM-erőforrás neve.
properties.applicationId	string	Az alkalmazás azonosítója.
properties.displayName	string	Az alkalmazás megjelenítendő neve.
properties.state	AppState	Az alkalmazás aktuális állapota.
properties.subdomain	string	Az alkalmazás altartománya.
properties.template	string	Az alkalmazássablon azonosítója, amely egy terv, amely meghatározza az alkalmazás jellemzőit és viselkedését. Választható; ha nincs megadva, akkor az alapértelmezett érték egy üres terv, és lehetővé teszi az alkalmazás teljesen új alapoktól való meghatározását.
sku	AppSkuInfo	Érvényes példány-termékváltozat.
tags	object	Az erőforráscímkék.
type	string	Az erőforrás típusa.

AppSku

A termékváltozat neve.

Name	Típus	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Az IoT Central-alkalmazás termékváltozatával kapcsolatos információk.

Name	Típus	Description
name	AppSku	A termékváltozat neve.

AppState

Az alkalmazás aktuális állapota.

Name	Típus	Description
created	string
suspended	string

CloudError

Hiba részletei.

Name	Típus	Description
error.code	string	A hibakód.
error.details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
error.message	string	A hibaüzenet.
error.target	string	Az adott hiba célja.

CloudErrorBody

A hibaválasz részletei.

Name	Típus	Description
code	string	A hibakód.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibaüzenet.
target	string	Az adott hiba célja.

SystemAssignedServiceIdentity

Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt vagy nincs)

Name	Típus	Description
principalId	string	A rendszer által hozzárendelt identitás szolgáltatásnév-azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string	A rendszer által hozzárendelt identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	SystemAssignedServiceIdentityType	A felügyeltszolgáltatás-identitás típusa (rendszer által hozzárendelt vagy egyik sem).

SystemAssignedServiceIdentityType

A felügyeltszolgáltatás-identitás típusa (rendszer által hozzárendelt vagy egyik sem).

Name	Típus	Description
None	string
SystemAssigned	string

Megosztás a következőn keresztül:

Apps - Get

URI-paraméterek

Válaszok

Biztonság

azure_auth

Scopes

Példák

Apps_Get

Sample Request

Sample Response

Definíciók

App

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

További források