Services - List By Subscription

Service:: Azure Spring Apps

Version d'API:: 2023-12-01

Gère les requêtes pour répertorier toutes les ressources d’un abonnement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	Obtient l’ID d’abonnement qui identifie de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ServiceResourceList	Succès. La réponse décrit la liste des services dans l’abonnement.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Services_ListBySubscription

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
ClusterResourceProperties	Charge utile des propriétés de service
createdByType	Type d’identité qui a créé la ressource.
IngressConfig	Charge utile de configuration d’entrée pour la ressource Azure Spring Apps.
lastModifiedByType	Type d’identité qui a modifié la ressource pour la dernière fois.
MarketplaceResource	Achat d’un produit tiers pour une instance Azure Spring Apps
NetworkProfile	Charge utile du profil réseau de service
OutboundIPs	Ressources IP sortantes souhaitées pour la ressource Azure Spring Apps.
PowerState	État de l’alimentation du service
ProvisioningState	État d’approvisionnement du service
RequiredTraffic	Trafic entrant ou sortant requis pour la ressource Azure Spring Apps.
ServiceResource	Ressource de service
ServiceResourceList	Objet qui inclut un tableau de ressources de service et un lien possible pour le jeu suivant
ServiceVNetAddons	Paramètres de service supplémentaires dans l’instance d’injection de réseau virtuel
Sku	Référence SKU d’Azure Spring Apps
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
trafficDirection	Direction du trafic requis

CloudError

Object

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur du service.

CloudErrorBody

Object

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

ClusterResourceProperties

Object

Charge utile des propriétés de service

Nom	Type	Valeur par défaut	Description
fqdn	string		Nom dns complet de l’instance de service
marketplaceResource	MarketplaceResource		Achat d’un produit tiers de la ressource de service.
networkProfile	NetworkProfile		Profil réseau du service
powerState	PowerState		État de l’alimentation du service
provisioningState	ProvisioningState		État d’approvisionnement du service
serviceId	string		ID ServiceInstanceEntity qui identifie de façon unique une ressource créée
version	integer (int32)		Version du service
vnetAddons	ServiceVNetAddons		Paramètres de service supplémentaires dans l’instance d’injection de réseau virtuel
zoneRedundant	boolean	False

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

IngressConfig

Object

Charge utile de configuration d’entrée pour la ressource Azure Spring Apps.

Nom	Type	Description
readTimeoutInSeconds	integer (int32)	Délai de lecture d’entrée en secondes.

lastModifiedByType

Énumération

Type d’identité qui a modifié la ressource pour la dernière fois.

Valeur	Description
User
Application
ManagedIdentity
Key

MarketplaceResource

Object

Achat d’un produit tiers pour une instance Azure Spring Apps

Nom	Type	Description
plan	string	ID de plan de l’artefact tiers en cours d’acquisition.
product	string	Artefact tiers en cours d’acquisition.
publisher	string	ID de l’éditeur de l’artefact tiers en cours d’achat.

NetworkProfile

Object

Charge utile du profil réseau de service

Nom	Type	Description
appNetworkResourceGroup	string	Nom du groupe de ressources contenant des ressources réseau pour les applications clientes dans Azure Spring Apps
appSubnetId	string	ID de ressource complet du sous-réseau pour héberger des applications client dans Azure Spring Apps
ingressConfig	IngressConfig	Charge utile de configuration d’entrée pour la ressource Azure Spring Apps.
outboundIPs	OutboundIPs	Ressources IP sortantes souhaitées pour la ressource Azure Spring Apps.
outboundType	string	Type de trafic de sortie des instances de réseau virtuel Azure Spring Apps.
requiredTraffics	RequiredTraffic[]	Trafics entrants ou sortants requis pour la ressource Azure Spring Apps.
serviceCidr	string	CIDR réservé au service Azure Spring Apps
serviceRuntimeNetworkResourceGroup	string	Nom du groupe de ressources contenant des ressources réseau d’Azure Spring Apps Service Runtime
serviceRuntimeSubnetId	string	ID de ressource complet du sous-réseau pour héberger Azure Spring Apps Service Runtime

OutboundIPs

Object

Ressources IP sortantes souhaitées pour la ressource Azure Spring Apps.

Nom	Type	Description
publicIPs	string[]	Liste des adresses IP publiques.

PowerState

Énumération

État de l’alimentation du service

Valeur	Description
Running
Stopped

ProvisioningState

Énumération

État d’approvisionnement du service

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

RequiredTraffic

Object

Trafic entrant ou sortant requis pour la ressource Azure Spring Apps.

Nom	Type	Description
direction	trafficDirection	Direction du trafic requis
fqdns	string[]	Liste des noms de domaine complets du trafic requis
ips	string[]	Liste ip du trafic requis
port	integer (int32)	Port du trafic requis
protocol	string	Protocole du trafic requis

ServiceResource

Object

Ressource de service

Nom	Type	Description
id	string	ID de ressource complet pour la ressource.
location	string	Emplacement GÉOGRAPHIQUE de la ressource.
name	string	Nom de la ressource.
properties	ClusterResourceProperties	Propriétés de la ressource de service
sku	Sku	Référence SKU de la ressource de service
systemData	SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object	Balises du service qui est une liste de paires clé-valeur qui décrivent la ressource.
type	string	Type de la ressource.

ServiceResourceList

Object

Objet qui inclut un tableau de ressources de service et un lien possible pour le jeu suivant

Nom	Type	Description
nextLink	string	Le client d’URL doit utiliser pour récupérer la page suivante (par pagination côté serveur). Il est null pour l’instant, ajouté pour une utilisation ultérieure.
value	ServiceResource[]	Collection de ressources de service

ServiceVNetAddons

Object

Paramètres de service supplémentaires dans l’instance d’injection de réseau virtuel

Nom	Type	Valeur par défaut	Description
dataPlanePublicEndpoint	boolean	False	Indique si les composants du plan de données (flux de journal, connexion d’application, débogage distant) dans l’instance d’injection de réseau virtuel peuvent être accessibles à partir d’Internet.
logStreamPublicEndpoint	boolean	False	Indique si le flux de journal dans l’instance d’injection de réseau virtuel est accessible à partir d’Internet.

Sku

Object

Référence SKU d’Azure Spring Apps

Nom	Type	Valeur par défaut	Description
capacity	integer (int32)		Capacité actuelle de la ressource cible
name	string	S0	Nom de la référence SKU
tier	string	Standard	Niveau de la référence SKU

SystemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la modification de ressource (UTC).
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	lastModifiedByType	Type d’identité qui a modifié la ressource pour la dernière fois.

trafficDirection

Énumération

Direction du trafic requis

Valeur	Description
Inbound
Outbound

Partager via

Services - List By Subscription

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Services_ListBySubscription

Exemple de requête

Exemple de réponse

Définitions

CloudError

CloudErrorBody

ClusterResourceProperties

createdByType

IngressConfig

lastModifiedByType

MarketplaceResource

NetworkProfile

OutboundIPs

PowerState

ProvisioningState

RequiredTraffic

ServiceResource

ServiceResourceList

ServiceVNetAddons

Sku

SystemData

trafficDirection