Services - List By Subscription

Služba:: Azure Spring Apps

Verze rozhraní API:: 2023-12-01

Zpracovává žádosti o výpis všech prostředků v předplatném.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/Spring?api-version=2023-12-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Získá ID předplatného, které jednoznačně identifikuje předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ServiceResourceList	Úspěch. Odpověď popisuje seznam služeb v předplatném.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Services_ListBySubscription

Ukázkový požadavek

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AppPlatform/Spring?api-version=2023-12-01


/**
 * Samples for Services List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * Services_ListBySubscription.json
     */
    /**
     * Sample code: Services_ListBySubscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void servicesListBySubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getServices().list(com.azure.core.util.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.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python services_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 = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.services.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_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 armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListBySubscription.json
func ExampleServicesClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewServicesClient().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.ServiceResourceList = armappplatform.ServiceResourceList{
		// 	Value: []*armappplatform.ServiceResource{
		// 		{
		// 			Name: to.Ptr("myservice"),
		// 			Type: to.Ptr("Microsoft.AppPlatform/Spring"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice"),
		// 			SystemData: &armappplatform.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
		// 				CreatedBy: to.Ptr("sample-user"),
		// 				CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("sample-user"),
		// 				LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
		// 			},
		// 			Location: to.Ptr("eastus"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 			},
		// 			Properties: &armappplatform.ClusterResourceProperties{
		// 				NetworkProfile: &armappplatform.NetworkProfile{
		// 					IngressConfig: &armappplatform.IngressConfig{
		// 						ReadTimeoutInSeconds: to.Ptr[int32](300),
		// 					},
		// 					OutboundIPs: &armappplatform.NetworkProfileOutboundIPs{
		// 						PublicIPs: []*string{
		// 							to.Ptr("20.39.3.173"),
		// 							to.Ptr("40.64.67.13")},
		// 						},
		// 						RequiredTraffics: []*armappplatform.RequiredTraffic{
		// 							{
		// 								Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
		// 								IPs: []*string{
		// 									to.Ptr("20.62.211.25"),
		// 									to.Ptr("52.188.47.226")},
		// 									Port: to.Ptr[int32](443),
		// 									Protocol: to.Ptr("TCP"),
		// 								},
		// 								{
		// 									Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
		// 									IPs: []*string{
		// 										to.Ptr("20.62.211.25"),
		// 										to.Ptr("52.188.47.226")},
		// 										Port: to.Ptr[int32](1194),
		// 										Protocol: to.Ptr("UDP"),
		// 									},
		// 									{
		// 										Direction: to.Ptr(armappplatform.TrafficDirectionOutbound),
		// 										IPs: []*string{
		// 											to.Ptr("20.62.211.25"),
		// 											to.Ptr("52.188.47.226")},
		// 											Port: to.Ptr[int32](9000),
		// 											Protocol: to.Ptr("TCP"),
		// 									}},
		// 								},
		// 								ProvisioningState: to.Ptr(armappplatform.ProvisioningStateSucceeded),
		// 								ServiceID: to.Ptr("12345678abcd1234abcd12345678abcd"),
		// 							},
		// 							SKU: &armappplatform.SKU{
		// 								Name: to.Ptr("S0"),
		// 								Tier: to.Ptr("Standard"),
		// 							},
		// 					}},
		// 				}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Handles requests to list all resources in a subscription.
 *
 * @summary Handles requests to list all resources in a subscription.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_ListBySubscription.json
 */
async function servicesListBySubscription() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.services.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "serviceId": "12345678abcd1234abcd12345678abcd",
        "networkProfile": {
          "outboundIPs": {
            "publicIPs": [
              "20.39.3.173",
              "40.64.67.13"
            ]
          },
          "ingressConfig": {
            "readTimeoutInSeconds": 300
          },
          "requiredTraffics": [
            {
              "protocol": "TCP",
              "port": 443,
              "ips": [
                "20.62.211.25",
                "52.188.47.226"
              ],
              "direction": "Outbound"
            },
            {
              "protocol": "UDP",
              "port": 1194,
              "ips": [
                "20.62.211.25",
                "52.188.47.226"
              ],
              "direction": "Outbound"
            },
            {
              "protocol": "TCP",
              "port": 9000,
              "ips": [
                "20.62.211.25",
                "52.188.47.226"
              ],
              "direction": "Outbound"
            }
          ]
        }
      },
      "systemData": {
        "createdBy": "sample-user",
        "createdByType": "User",
        "createdAt": "2021-08-11T03:16:03.944Z",
        "lastModifiedBy": "sample-user",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-11T03:17:03.944Z"
      },
      "type": "Microsoft.AppPlatform/Spring",
      "sku": {
        "name": "S0",
        "tier": "Standard"
      },
      "location": "eastus",
      "tags": {
        "key1": "value1"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice",
      "name": "myservice"
    }
  ]
}

Definice

Name	Description
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
ClusterResourceProperties	Datová část vlastností služby
createdByType	Typ identity, která prostředek vytvořila.
IngressConfig	Datová část konfigurace příchozího přenosu dat pro prostředek Azure Spring Apps
lastModifiedByType	Typ identity, která naposledy změnila prostředek.
MarketplaceResource	Nákup produktu třetí strany pro jednu instanci Azure Spring Apps
NetworkProfile	Datová část profilu sítě služby
OutboundIPs	Požadované odchozí prostředky IP adresy pro prostředek Azure Spring Apps
PowerState	Stav napájení služby
ProvisioningState	Stav zřizování služby
RequiredTraffic	Požadovaný příchozí nebo odchozí provoz pro prostředek Azure Spring Apps
ServiceResource	Prostředek služby
ServiceResourceList	Objekt, který obsahuje pole prostředků služby a možné propojení pro další sadu
ServiceVNetAddons	Další nastavení služby v instanci injektáže virtuální sítě
Sku	Skladová položka služby Azure Spring Apps
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
trafficDirection	Směr požadovaného provozu

CloudError

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď ze služby.

CloudErrorBody

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

ClusterResourceProperties

Objekt

Datová část vlastností služby

Name	Typ	Default value	Description
fqdn	string		Plně kvalifikovaný název DNS instance služby
marketplaceResource	MarketplaceResource		Nákup produktu třetí strany prostředku služby
networkProfile	NetworkProfile		Profil sítě služby
powerState	PowerState		Stav napájení služby
provisioningState	ProvisioningState		Stav zřizování služby
serviceId	string		ServiceInstanceEntity ID, které jednoznačně identifikuje vytvořený prostředek
version	integer (int32)		Verze služby
vnetAddons	ServiceVNetAddons		Další nastavení služby v instanci injektáže virtuální sítě
zoneRedundant	boolean	False

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

IngressConfig

Objekt

Datová část konfigurace příchozího přenosu dat pro prostředek Azure Spring Apps

Name	Typ	Description
readTimeoutInSeconds	integer (int32)	Časový limit čtení příchozího přenosu dat v sekundách vypršel.

lastModifiedByType

Výčet

Typ identity, která naposledy změnila prostředek.

Hodnota	Description
User
Application
ManagedIdentity
Key

MarketplaceResource

Objekt

Nákup produktu třetí strany pro jednu instanci Azure Spring Apps

Name	Typ	Description
plan	string	ID plánu artefaktu třetí strany, který se pořiuje.
product	string	Artefakt třetí strany, který se pořizován
publisher	string	ID vydavatele zakoupeného artefaktu třetí strany.

NetworkProfile

Objekt

Datová část profilu sítě služby

Name	Typ	Description
appNetworkResourceGroup	string	Název skupiny prostředků obsahující síťové prostředky pro zákaznické aplikace v Azure Spring Apps
appSubnetId	string	Plně kvalifikované ID prostředku podsítě pro hostování zákaznických aplikací v Azure Spring Apps
ingressConfig	IngressConfig	Datová část konfigurace příchozího přenosu dat pro prostředek Azure Spring Apps
outboundIPs	OutboundIPs	Požadované odchozí prostředky IP adresy pro prostředek Azure Spring Apps
outboundType	string	Typ odchozího provozu instancí virtuální sítě Azure Spring Apps.
requiredTraffics	RequiredTraffic[]	Požadované příchozí nebo odchozí přenosy pro prostředek Azure Spring Apps
serviceCidr	string	Rezervovaná CIDR služby Azure Spring Apps
serviceRuntimeNetworkResourceGroup	string	Název skupiny prostředků obsahující síťové prostředky modulu Runtime služby Azure Spring Apps
serviceRuntimeSubnetId	string	Plně kvalifikované ID prostředku podsítě pro hostování modulu runtime služby Azure Spring Apps

OutboundIPs

Objekt

Požadované odchozí prostředky IP adresy pro prostředek Azure Spring Apps

Name	Typ	Description
publicIPs	string[]	Seznam veřejných IP adres

PowerState

Výčet

Stav napájení služby

Hodnota	Description
Running
Stopped

ProvisioningState

Výčet

Stav zřizování služby

Hodnota	Description
Creating
Updating
Starting
Stopping
Deleting
Deleted
Succeeded
Failed
Moving
Moved
MoveFailed

RequiredTraffic

Objekt

Požadovaný příchozí nebo odchozí provoz pro prostředek Azure Spring Apps

Name	Typ	Description
direction	trafficDirection	Směr požadovaného provozu
fqdns	string[]	Seznam plně kvalifikovaných názvů domén požadovaných přenosů
ips	string[]	Seznam IP adres požadovaného provozu
port	integer (int32)	Port požadovaného provozu
protocol	string	Protokol požadovaného provozu

ServiceResource

Objekt

Prostředek služby

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek.
location	string	Geografické umístění prostředku.
name	string	Název prostředku.
properties	ClusterResourceProperties	Vlastnosti prostředku služby
sku	Sku	Skladová položka prostředku služby
systemData	SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
tags	object	Značky služby, což je seznam párů klíč-hodnota, které popisují prostředek.
type	string	Typ prostředku.

ServiceResourceList

Objekt

Objekt, který obsahuje pole prostředků služby a možné propojení pro další sadu

Name	Typ	Description
nextLink	string	Klient adresy URL by měl použít k načtení další stránky (stránkování na straně serveru). Pro tuto chvíli je hodnota null, přidána pro budoucí použití.
value	ServiceResource[]	Kolekce prostředků služby

ServiceVNetAddons

Objekt

Další nastavení služby v instanci injektáže virtuální sítě

Name	Typ	Default value	Description
dataPlanePublicEndpoint	boolean	False	Určuje, jestli jsou komponenty roviny dat (stream protokolu, připojení aplikace, vzdálené ladění) v instanci injektáže virtuální sítě přístupné z internetu.
logStreamPublicEndpoint	boolean	False	Určuje, jestli se stream protokolu v instanci injektáže virtuální sítě dá získat přístup z internetu.

Sku

Objekt

Skladová položka služby Azure Spring Apps

Name	Typ	Default value	Description
capacity	integer (int32)		Aktuální kapacita cílového prostředku
name	string	S0	Název skladové položky
tier	string	Standard	Úroveň skladové položky

SystemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko změny prostředku (UTC).
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	lastModifiedByType	Typ identity, která naposledy změnila prostředek.

trafficDirection

Výčet

Směr požadovaného provozu

Hodnota	Description
Inbound
Outbound

Sdílet prostřednictvím

Services - List By Subscription

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Services_ListBySubscription

Ukázkový požadavek

Ukázková odpověď

Definice

CloudError

CloudErrorBody

ClusterResourceProperties

createdByType

IngressConfig

lastModifiedByType

MarketplaceResource

NetworkProfile

OutboundIPs

PowerState

ProvisioningState

RequiredTraffic

ServiceResource

ServiceResourceList

ServiceVNetAddons

Sku

SystemData

trafficDirection