Apps - List By Subscription

Referentie

Service:: IoT Central

API-versie:: 2021-06-01

Alle IoT Central-toepassingen in een abonnement ophalen.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De versie van de API.

Antwoorden

Name	Type	Description
200 OK	AppListResult	Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerde matrix van de metagegevens van alle IoT Central-toepassingen in het abonnement.
Other Status Codes	CloudError	DefaultErrorResponse

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Apps_ListBySubscription

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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
}

Definities

Name	Description
App	De IoT Central-toepassing.
AppListResult	Een lijst met IoT Central-toepassingen met een volgende koppeling.
AppSku	De naam van de SKU.
AppSkuInfo	Informatie over de SKU van de IoT Central-toepassing.
AppState	De huidige status van de toepassing.
CloudError	Foutdetails.
CloudErrorBody	Details van de foutreactie.
SystemAssignedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen of geen)
SystemAssignedServiceIdentityType	Type beheerde service-identiteit (door het systeem toegewezen of geen).

App

De IoT Central-toepassing.

Name	Type	Description
id	string	De ARM-resource-id.
identity	SystemAssignedServiceIdentity	De beheerde identiteiten voor de IoT Central-toepassing.
location	string	De resourcelocatie.
name	string	De naam van de ARM-resource.
properties.applicationId	string	De id van de toepassing.
properties.displayName	string	De weergavenaam van de toepassing.
properties.state	AppState	De huidige status van de toepassing.
properties.subdomain	string	Het subdomein van de toepassing.
properties.template	string	De id van de toepassingssjabloon, een blauwdruk die de kenmerken en het gedrag van een toepassing definieert. Optionele; als dit niet is opgegeven, wordt standaard een lege blauwdruk gebruikt en kan de toepassing helemaal opnieuw worden gedefinieerd.
sku	AppSkuInfo	Een geldige exemplaar-SKU.
tags	object	De resourcetags.
type	string	Het resourcetype.

AppListResult

Een lijst met IoT Central-toepassingen met een volgende koppeling.

Name	Type	Description
nextLink	string	De koppeling die wordt gebruikt om de volgende pagina van IoT Central-toepassingen op te halen.
value	App[]	Een lijst met IoT Central-toepassingen.

AppSku

De naam van de SKU.

Name	Type	Description
ST0	string
ST1	string
ST2	string

AppSkuInfo

Informatie over de SKU van de IoT Central-toepassing.

Name	Type	Description
name	AppSku	De naam van de SKU.

AppState

De huidige status van de toepassing.

Name	Type	Description
created	string
suspended	string

CloudError

Foutdetails.

Name	Type	Description
error.code	string	De foutcode.
error.details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
error.message	string	Het foutbericht.
error.target	string	Het doel van de specifieke fout.

CloudErrorBody

Details van de foutreactie.

Name	Type	Description
code	string	De foutcode.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Het foutbericht.
target	string	Het doel van de specifieke fout.

SystemAssignedServiceIdentity

Beheerde service-identiteit (door het systeem toegewezen of geen)

Name	Type	Description
principalId	string	De service-principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
tenantId	string	De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen opgegeven voor een door het systeem toegewezen identiteit.
type	SystemAssignedServiceIdentityType	Type beheerde service-identiteit (door het systeem toegewezen of geen).

SystemAssignedServiceIdentityType

Type beheerde service-identiteit (door het systeem toegewezen of geen).

Name	Type	Description
None	string
SystemAssigned	string

Delen via

Apps - List By Subscription

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Apps_ListBySubscription

Voorbeeldaanvraag

Voorbeeldrespons

Definities

App

AppListResult

AppSku

AppSkuInfo

AppState

CloudError

CloudErrorBody

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

Aanvullende resources