Apps - Get

Referencia

Service:: IoT Central

API Version:: 2021-06-01

Obtenga los metadatos de una aplicación de IoT Central.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene la aplicación de IoT Central.
resourceName	path	True	string	El nombre del recurso arm de la aplicación de IoT Central.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	App	El cuerpo contiene todas las propiedades que no son de seguridad de la aplicación de IoT Central. Las propiedades relacionadas con la seguridad se establecen en null.
Other Status Codes	CloudError	Respuesta de error predeterminada

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
App	La aplicación de IoT Central.
AppSku	El nombre de la SKU.
AppSkuInfo	Información sobre la SKU de la aplicación de IoT Central.
AppState	Estado actual de la aplicación.
CloudError	Detalles del error.
CloudErrorBody	Detalles de la respuesta de error.
SystemAssignedServiceIdentity	Identidad de servicio administrada (asignada por el sistema o ninguna)
SystemAssignedServiceIdentityType	Tipo de identidad de servicio administrada (asignada por el sistema o ninguna).

App

La aplicación de IoT Central.

Nombre	Tipo	Description
id	string	Identificador de recursos de ARM.
identity	SystemAssignedServiceIdentity	Identidades administradas para la aplicación de IoT Central.
location	string	Ubicación del recurso.
name	string	Nombre del recurso de ARM.
properties.applicationId	string	El identificador de la aplicación.
properties.displayName	string	Nombre para mostrar de la aplicación.
properties.state	AppState	Estado actual de la aplicación.
properties.subdomain	string	Subdominio de la aplicación.
properties.template	string	El identificador de la plantilla de aplicación, que es un plano técnico que define las características y los comportamientos de una aplicación. Opcional; Si no se especifica, el valor predeterminado es un plano técnico en blanco y permite definir la aplicación desde cero.
sku	AppSkuInfo	Una SKU de instancia válida.
tags	object	Etiquetas del recurso.
type	string	El tipo de recurso.

AppSku

El nombre de la SKU.

Nombre	Tipo	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Información sobre la SKU de la aplicación de IoT Central.

Nombre	Tipo	Description
name	AppSku	El nombre de la SKU.

AppState

Estado actual de la aplicación.

Nombre	Tipo	Description
created	string
suspended	string

CloudError

Detalles del error.

Nombre	Tipo	Description
error.code	string	Código de error.
error.details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
error.message	string	El mensaje de error.
error.target	string	Destino del error concreto.

CloudErrorBody

Detalles de la respuesta de error.

Nombre	Tipo	Description
code	string	Código de error.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	El mensaje de error.
target	string	Destino del error concreto.

SystemAssignedServiceIdentity

Identidad de servicio administrada (asignada por el sistema o ninguna)

Nombre	Tipo	Description
principalId	string	Identificador de la entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	SystemAssignedServiceIdentityType	Tipo de identidad de servicio administrada (asignada por el sistema o ninguna).

SystemAssignedServiceIdentityType

Tipo de identidad de servicio administrada (asignada por el sistema o ninguna).

Nombre	Tipo	Description
None	string
SystemAssigned	string

Compartir a través de

Apps - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

Apps_Get

Sample Request

Sample Response

Definiciones

App

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Recursos adicionales