Apps - Get

Referência

Serviço:: IoT Central

Versão da API:: 2021-06-01

Obtenha os metadados de uma aplicação do IoT Central.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém a aplicação do IoT Central.
resourceName	path	True	string	O nome do recurso arm da aplicação IoT Central.
subscriptionId	path	True	string	O identificador da subscrição.
api-version	query	True	string	A versão da API.

Respostas

Name	Tipo	Description
200 OK	App	O corpo contém todas as propriedades não relacionadas com segurança da aplicação do IoT Central. As propriedades relacionadas com a segurança estão definidas como nulas.
Other Status Codes	CloudError	Resposta de erro predefinida

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Apps_Get

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: default

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

Definições

Name	Description
App	A aplicação IoT Central.
AppSku	O nome do SKU.
AppSkuInfo	Informações sobre o SKU da aplicação do IoT Central.
AppState	O estado atual da aplicação.
CloudError	Detalhes do erro.
CloudErrorBody	Detalhes da resposta ao erro.
SystemAssignedServiceIdentity	Identidade de serviço gerida (ou sistema atribuído ou nenhum)
SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerida (atribuída pelo sistema ou nenhuma).

App

A aplicação IoT Central.

Name	Tipo	Description
id	string	O identificador de recursos do ARM.
identity	SystemAssignedServiceIdentity	As identidades geridas da aplicação IoT Central.
location	string	A localização do recurso.
name	string	O nome do recurso do ARM.
properties.applicationId	string	O ID da aplicação.
properties.displayName	string	O nome a apresentar da aplicação.
properties.state	AppState	O estado atual da aplicação.
properties.subdomain	string	O subdomínio da aplicação.
properties.template	string	O ID do modelo de aplicação, que é um esquema que define as características e os comportamentos de uma aplicação. Opcional; se não for especificado, a predefinição é um esquema em branco e permite que a aplicação seja definida do zero.
sku	AppSkuInfo	Um SKU de instância válido.
tags	object	As etiquetas de recursos.
type	string	O tipo de recurso.

AppSku

O nome do SKU.

Name	Tipo	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informações sobre o SKU da aplicação do IoT Central.

Name	Tipo	Description
name	AppSku	O nome do SKU.

AppState

O estado atual da aplicação.

Name	Tipo	Description
created	string
suspended	string

CloudError

Detalhes do erro.

Name	Tipo	Description
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro específico.

CloudErrorBody

Detalhes da resposta ao erro.

Name	Tipo	Description
code	string	O código de erro.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	A mensagem de erro.
target	string	O destino do erro específico.

SystemAssignedServiceIdentity

Identidade de serviço gerida (ou sistema atribuído ou nenhum)

Name	Tipo	Description
principalId	string	O ID do principal de serviço da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	O ID de inquilino da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerida (atribuída pelo sistema ou nenhuma).

SystemAssignedServiceIdentityType

Tipo de identidade de serviço gerida (atribuída pelo sistema ou nenhuma).

Name	Tipo	Description
None	string
SystemAssigned	string

Partilhar via

Apps - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Apps_Get

Pedido de amostra

Resposta da amostra

Definições

App

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Recursos adicionais