Services - List

Referentie

Service:: Azure Spring Apps

API-versie:: 2023-12-01

Verwerkt aanvragen om alle resources in een resourcegroep weer te geven.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
subscriptionId	path	True	string	Hiermee haalt u de abonnements-id op waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ServiceResourceList	Succes. In het antwoord wordt de lijst met services in de resourcegroep beschreven.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

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

Services_List

Voorbeeldaanvraag

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


/**
 * Samples for Services ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_List.json
     */
    /**
     * Sample code: Services_List.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void servicesList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getServices().listByResourceGroup("myResourceGroup",
            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.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(
        resource_group_name="myResourceGroup",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_List.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_List.json
func ExampleServicesClient_NewListPager() {
	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().NewListPager("myResourceGroup", 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 resource group.
 *
 * @summary Handles requests to list all resources in a resource group.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/Services_List.json
 */
async function servicesList() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.services.list(resourceGroupName)) {
    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

Voorbeeldrespons

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

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
ClusterResourceProperties	Nettolading van service-eigenschappen
createdByType	Het type identiteit waarmee de resource is gemaakt.
IngressConfig	Nettolading voor inkomend verkeer voor Azure Spring Apps-resource.
lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.
MarketplaceResource	Product van derden aanschaffen voor één Azure Spring Apps-exemplaar
NetworkProfile	Nettolading van servicenetwerkprofiel
OutboundIPs	Gewenste uitgaande IP-resources voor Azure Spring Apps-resource.
PowerState	Energiestatus van de service
ProvisioningState	Inrichtingsstatus van de service
RequiredTraffic	Vereist inkomend of uitgaand verkeer voor Azure Spring Apps-resource.
ServiceResource	Serviceresource
ServiceResourceList	Object met een matrix van servicebronnen en een mogelijke koppeling voor de volgende set
ServiceVNetAddons	Aanvullende service-instellingen in vnet-injectieexemplaren
Sku	SKU van Azure Spring Apps
SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
trafficDirection	De richting van het vereiste verkeer

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Een foutreactie van de service.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

ClusterResourceProperties

Object

Nettolading van service-eigenschappen

Name	Type	Default value	Description
fqdn	string		Volledig gekwalificeerde DNS-naam van het service-exemplaar
marketplaceResource	MarketplaceResource		Het aanschaffen van een product van derden van de serviceresource.
networkProfile	NetworkProfile		Netwerkprofiel van de service
powerState	PowerState		Energiestatus van de service
provisioningState	ProvisioningState		Inrichtingsstatus van de service
serviceId	string		ServiceInstanceEntity-id die een gemaakte resource uniek identificeert
version	integer (int32)		Versie van de service
vnetAddons	ServiceVNetAddons		Aanvullende service-instellingen in vnet-injectieexemplaren
zoneRedundant	boolean	False

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

IngressConfig

Object

Nettolading voor inkomend verkeer voor Azure Spring Apps-resource.

Name	Type	Description
readTimeoutInSeconds	integer (int32)	Time-out voor inkomende leesbewerkingen in seconden.

lastModifiedByType

Inventarisatie

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Waarde	Description
Application
Key
ManagedIdentity
User

MarketplaceResource

Object

Product van derden aanschaffen voor één Azure Spring Apps-exemplaar

Name	Type	Description
plan	string	De plan-id van het artefact van derden dat wordt aangeschaft.
product	string	Het artefact van derden dat wordt aangeschaft.
publisher	string	De uitgever-id van het artefact van derden dat wordt gekocht.

NetworkProfile

Object

Nettolading van servicenetwerkprofiel

Name	Type	Description
appNetworkResourceGroup	string	Naam van de resourcegroep met netwerkresources voor klant-apps in Azure Spring Apps
appSubnetId	string	Volledig gekwalificeerde resource-id van het subnet voor het hosten van klant-apps in Azure Spring Apps
ingressConfig	IngressConfig	Nettolading voor inkomend verkeer voor Azure Spring Apps-resource.
outboundIPs	OutboundIPs	Gewenste uitgaande IP-resources voor Azure Spring Apps-resource.
outboundType	string	Het uitgaande verkeerstype van VNet-exemplaren van Azure Spring Apps.
requiredTraffics	RequiredTraffic[]	Vereist inkomend of uitgaand verkeer voor Azure Spring Apps-resource.
serviceCidr	string	Gereserveerde CIDR voor Azure Spring Apps-service
serviceRuntimeNetworkResourceGroup	string	Naam van de resourcegroep met netwerkresources van Azure Spring Apps Service Runtime
serviceRuntimeSubnetId	string	Volledig gekwalificeerde resource-id van het subnet voor het hosten van Azure Spring Apps Service Runtime

OutboundIPs

Object

Gewenste uitgaande IP-resources voor Azure Spring Apps-resource.

Name	Type	Description
publicIPs	string[]	Een lijst met openbare IP-adressen.

PowerState

Inventarisatie

Energiestatus van de service

Waarde	Description
Running
Stopped

ProvisioningState

Inventarisatie

Inrichtingsstatus van de service

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

RequiredTraffic

Object

Vereist inkomend of uitgaand verkeer voor Azure Spring Apps-resource.

Name	Type	Description
direction	trafficDirection	De richting van het vereiste verkeer
fqdns	string[]	De FQDN-lijst met vereist verkeer
ips	string[]	De IP-lijst met vereist verkeer
port	integer (int32)	De poort van het vereiste verkeer
protocol	string	Het protocol van vereist verkeer

ServiceResource

Object

Serviceresource

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource.
location	string	De GEO-locatie van de resource.
name	string	De naam van de resource.
properties	ClusterResourceProperties	Eigenschappen van de serviceresource
sku	Sku	SKU van de serviceresource
systemData	SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags	object	Tags van de service, een lijst met sleutel-waardeparen die de resource beschrijven.
type	string	Het type resource.

ServiceResourceList

Object

Object met een matrix van servicebronnen en een mogelijke koppeling voor de volgende set

Name	Type	Description
nextLink	string	URL-client moet worden gebruikt om de volgende pagina op te halen (paging aan de serverzijde). Het is nu null, toegevoegd voor toekomstig gebruik.
value	ServiceResource[]	Verzameling servicebronnen

ServiceVNetAddons

Object

Aanvullende service-instellingen in vnet-injectieexemplaren

Name	Type	Default value	Description
dataPlanePublicEndpoint	boolean	False	Hiermee wordt aangegeven of de onderdelen van het gegevensvlak (logboekstream, app connect, externe foutopsporing) in het vnet-injectieexemplaren toegankelijk zijn via internet.
logStreamPublicEndpoint	boolean	False	Hiermee wordt aangegeven of de logboekstream in het vnet-injectieexemplaren toegankelijk is via internet.

Sku

Object

SKU van Azure Spring Apps

Name	Type	Default value	Description
capacity	integer (int32)		Huidige capaciteit van de doelresource
name	string	S0	Naam van de SKU
tier	string	Standard	Laag van de SKU

SystemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van resourcewijziging (UTC).
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

trafficDirection

Inventarisatie

De richting van het vereiste verkeer

Waarde	Description
Inbound
Outbound

Delen via

Services - List

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Services_List

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CloudError

CloudErrorBody

ClusterResourceProperties

createdByType

IngressConfig

lastModifiedByType

MarketplaceResource

NetworkProfile

OutboundIPs

PowerState

ProvisioningState

RequiredTraffic

ServiceResource

ServiceResourceList

ServiceVNetAddons

Sku

SystemData

trafficDirection

Aanvullende resources