Apps - List By Subscription

Başvuru

Hizmet:: IoT Central

API Sürümü:: 2021-06-01

Bir abonelikteki tüm IoT Central Uygulamalarını alın.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
api-version	query	True	string	API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	AppListResult	Bu zaman uyumlu bir işlemdir. Gövde, abonelikteki tüm IoT Central Uygulamalarından meta verilerin JSON serileştirilmiş bir dizisini içerir.
Other Status Codes	CloudError	DefaultErrorResponse

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Apps_ListBySubscription

Örnek isteği

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/iotApps?api-version=2021-06-01

import com.azure.core.util.Context;

/** Samples for Apps List. */
public final class Main {
    /*
     * x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_ListBySubscription.json
     */
    /**
     * Sample code: Apps_ListBySubscription.
     *
     * @param manager Entry point to IotCentralManager.
     */
    public static void appsListBySubscription(com.azure.resourcemanager.iotcentral.IotCentralManager manager) {
        manager.apps().list(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_list_by_subscription.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.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2021-06-01/examples/Apps_ListBySubscription.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_ListBySubscription.json
func ExampleAppsClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewAppsClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AppListResult = armiotcentral.AppListResult{
		// 	Value: []*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

Örnek yanıt

Durum kodu:: 200

code: 200

{
  "value": [
    {
      "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"
      }
    }
  ],
  "nextLink": null
}

Tanımlar

Name	Description
App	IoT Central uygulaması.
AppListResult	Sonraki bağlantıya sahip IoT Central Uygulamalarının listesi.
AppSku	SKU'nun adı.
AppSkuInfo	IoT Central uygulamasının SKU'su hakkında bilgi.
AppState	Uygulamanın geçerli durumu.
CloudError	Hata ayrıntıları.
CloudErrorBody	Hata yanıtının ayrıntıları.
SystemAssignedServiceIdentity	Yönetilen hizmet kimliği (sistem atanmış veya yok)
SystemAssignedServiceIdentityType	Yönetilen hizmet kimliğinin türü (sistem atanmış veya yok).

App

IoT Central uygulaması.

Name	Tür	Description
id	string	ARM kaynak tanımlayıcısı.
identity	SystemAssignedServiceIdentity	IoT Central uygulaması için yönetilen kimlikler.
location	string	Kaynak konumu.
name	string	ARM kaynak adı.
properties.applicationId	string	Uygulamanın kimliği.
properties.displayName	string	Uygulamanın görünen adı.
properties.state	AppState	Uygulamanın geçerli durumu.
properties.subdomain	string	Uygulamanın alt etki alanı.
properties.template	string	Bir uygulamanın özelliklerini ve davranışlarını tanımlayan bir şema olan uygulama şablonunun kimliği. Isteğe bağlı; belirtilmezse, varsayılan olarak boş bir şemaya ayarlanır ve uygulamanın sıfırdan tanımlanmasına izin verir.
sku	AppSkuInfo	Geçerli bir örnek SKU'su.
tags	object	Kaynak etiketleri.
type	string	Kaynak türü.

AppListResult

Sonraki bağlantıya sahip IoT Central Uygulamalarının listesi.

Name	Tür	Description
nextLink	string	IoT Central Uygulamalarının sonraki sayfasını almak için kullanılan bağlantı.
value	App[]	IoT Central Uygulamalarının listesi.

AppSku

SKU'nun adı.

Name	Tür	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

IoT Central uygulamasının SKU'su hakkında bilgi.

Name	Tür	Description
name	AppSku	SKU'nun adı.

AppState

Uygulamanın geçerli durumu.

Name	Tür	Description
created	string
suspended	string

CloudError

Hata ayrıntıları.

Name	Tür	Description
error.code	string	Hata kodu.
error.details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
error.message	string	Hata iletisi.
error.target	string	Belirli bir hatanın hedefi.

CloudErrorBody

Hata yanıtının ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hata iletisi.
target	string	Belirli bir hatanın hedefi.

SystemAssignedServiceIdentity

Yönetilen hizmet kimliği (sistem atanmış veya yok)

Name	Tür	Description
principalId	string	Sistem tarafından atanan kimliğin hizmet sorumlusu kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
tenantId	string	Sistem tarafından atanan kimliğin kiracı kimliği. Bu özellik yalnızca sistem tarafından atanan kimlik için sağlanacaktır.
type	SystemAssignedServiceIdentityType	Yönetilen hizmet kimliğinin türü (sistem atanmış veya yok).

SystemAssignedServiceIdentityType

Yönetilen hizmet kimliğinin türü (sistem atanmış veya yok).

Name	Tür	Description
None	string
SystemAssigned	string

Aracılığıyla paylaş

Apps - List By Subscription

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

Apps_ListBySubscription

Örnek isteği

Örnek yanıt

Tanımlar

App

AppListResult

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Ek kaynaklar