Apps - Get

Riferimento

Servizio:: IoT Central

Versione API:: 2021-06-01

Ottenere i metadati di un'applicazione IoT Central.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente l'applicazione IoT Central.
resourceName	path	True	string	Nome della risorsa ARM dell'applicazione IoT Central.
subscriptionId	path	True	string	L'identificatore della sottoscrizione.
api-version	query	True	string	Versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	App	Il corpo contiene tutte le proprietà non di sicurezza dell'applicazione IoT Central. Le proprietà correlate alla sicurezza sono impostate su Null.
Other Status Codes	CloudError	Risposta di errore predefinita

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Apps_Get

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Codice di stato:: default

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

Definizioni

Nome	Descrizione
App	Applicazione IoT Central.
AppSku	Il nome della SKU.
AppSkuInfo	Informazioni sullo SKU dell'applicazione IoT Central.
AppState	Stato attuale dell'applicazione.
CloudError	Dettagli degli errori.
CloudErrorBody	Dettagli della risposta all'errore.
SystemAssignedServiceIdentity	Identità del servizio gestita (assegnata dal sistema o none)
SystemAssignedServiceIdentityType	Tipo di identità del servizio gestito (sistema assegnato o none).

App

Applicazione IoT Central.

Nome	Tipo	Descrizione
id	string	Identificatore di risorsa arm.
identity	SystemAssignedServiceIdentity	Identità gestite per l'applicazione IoT Central.
location	string	Percorso della risorsa.
name	string	Nome della risorsa ARM.
properties.applicationId	string	ID dell'applicazione.
properties.displayName	string	Nome visualizzato dell'applicazione.
properties.state	AppState	Stato attuale dell'applicazione.
properties.subdomain	string	Sottodominio dell'applicazione.
properties.template	string	ID del modello di applicazione, che è un progetto che definisce le caratteristiche e i comportamenti di un'applicazione. Opzionale; se non specificato, il valore predefinito è un progetto vuoto e consente di definire l'applicazione da zero.
sku	AppSkuInfo	SKU di istanza valido.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa.

AppSku

Il nome della SKU.

Nome	Tipo	Descrizione
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informazioni sullo SKU dell'applicazione IoT Central.

Nome	Tipo	Descrizione
name	AppSku	Il nome della SKU.

AppState

Stato attuale dell'applicazione.

Nome	Tipo	Descrizione
created	string
suspended	string

CloudError

Dettagli degli errori.

Nome	Tipo	Descrizione
error.code	string	Codice di errore.
error.details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
error.message	string	Messaggio di errore.
error.target	string	Destinazione dell'errore specifico.

CloudErrorBody

Dettagli della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

SystemAssignedServiceIdentity

Identità del servizio gestita (assegnata dal sistema o none)

Nome	Tipo	Descrizione
principalId	string	ID dell'entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
tenantId	string	ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
type	SystemAssignedServiceIdentityType	Tipo di identità del servizio gestito (sistema assegnato o none).

SystemAssignedServiceIdentityType

Tipo di identità del servizio gestito (sistema assegnato o none).

Nome	Tipo	Descrizione
None	string
SystemAssigned	string

Condividi tramite

Apps - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Apps_Get

Esempio di richiesta

Risposta di esempio

Definizioni

App

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Risorse aggiuntive