Services - List

服務:: Azure Spring Apps

API 版本:: 2023-12-01

處理列出資源群組中所有資源的要求。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure Resource Manager API 或入口網站取得此值。
subscriptionId	path	True	string	取得可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶標識碼。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	ServiceResourceList	成功。回應描述資源群組中的服務清單。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Services_List

範例要求

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

範例回覆

狀態碼:: 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"
    }
  ]
}

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
ClusterResourceProperties	服務屬性承載
createdByType	建立資源的身分識別類型。
IngressConfig	Azure Spring Apps 資源的輸入組態承載。
lastModifiedByType	上次修改資源的身分識別類型。
MarketplaceResource	購買一個 Azure Spring Apps 實例的第三方產品
NetworkProfile	服務網路配置檔承載
OutboundIPs	Azure Spring Apps 資源所需的輸出 IP 資源。
PowerState	服務的電源狀態
ProvisioningState	服務布建狀態
RequiredTraffic	Azure Spring Apps 資源所需的輸入或輸出流量。
ServiceResource	服務資源
ServiceResourceList	物件，其中包含服務資源的陣列，以及下一個集合的可能連結
ServiceVNetAddons	vnet 插入實例中的其他服務設定
Sku	Azure Spring Apps 的 SKU
SystemData	與建立和上次修改資源相關的元數據。
trafficDirection	所需流量的方向

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	來自服務的錯誤回應。

CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

ClusterResourceProperties

Object

服務屬性承載

名稱	類型	預設值	Description
fqdn	string		服務實例的完整 DNS 名稱
marketplaceResource	MarketplaceResource		購買服務資源的第三方產品。
networkProfile	NetworkProfile		服務的網路配置檔
powerState	PowerState		服務的電源狀態
provisioningState	ProvisioningState		服務布建狀態
serviceId	string		可唯一識別已建立資源的 ServiceInstanceEntity 標識符
version	integer (int32)		服務版本
vnetAddons	ServiceVNetAddons		vnet 插入實例中的其他服務設定
zoneRedundant	boolean	False

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

IngressConfig

Object

Azure Spring Apps 資源的輸入組態承載。

名稱	類型	Description
readTimeoutInSeconds	integer (int32)	輸入讀取逾時，以秒為單位。

lastModifiedByType

列舉型別

上次修改資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

MarketplaceResource

Object

購買一個 Azure Spring Apps 實例的第三方產品

名稱	類型	Description
plan	string	正在採購的第三方成品的計劃標識符。
product	string	正在採購的第三方成品。
publisher	string	要購買的第三方成品的發行者標識符。

NetworkProfile

Object

服務網路配置檔承載

名稱	類型	Description
appNetworkResourceGroup	string	包含 Azure Spring Apps 中客戶應用程式網路資源的資源群組名稱
appSubnetId	string	在 Azure Spring Apps 中裝載客戶應用程式之子網的完整資源識別碼
ingressConfig	IngressConfig	Azure Spring Apps 資源的輸入組態承載。
outboundIPs	OutboundIPs	Azure Spring Apps 資源所需的輸出 IP 資源。
outboundType	string	Azure Spring Apps VNet 實例的輸出流量類型。
requiredTraffics	RequiredTraffic[]	Azure Spring Apps 資源所需的輸入或輸出流量。
serviceCidr	string	Azure Spring Apps 服務保留 CIDR
serviceRuntimeNetworkResourceGroup	string	包含 Azure Spring Apps Service Runtime 網路資源的資源群組名稱
serviceRuntimeSubnetId	string	用來裝載 Azure Spring Apps Service Runtime 之子網的完整資源標識符

OutboundIPs

Object

Azure Spring Apps 資源所需的輸出 IP 資源。

名稱	類型	Description
publicIPs	string[]	公用IP位址的清單。

PowerState

列舉型別

服務的電源狀態

值	Description
Running
Stopped

ProvisioningState

列舉型別

服務布建狀態

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

RequiredTraffic

Object

Azure Spring Apps 資源所需的輸入或輸出流量。

名稱	類型	Description
direction	trafficDirection	所需流量的方向
fqdns	string[]	必要流量的 FQDN 列表
ips	string[]	必要流量的IP清單
port	integer (int32)	所需流量的埠
protocol	string	所需流量的通訊協定

ServiceResource

Object

服務資源

名稱	類型	Description
id	string	資源的完整資源標識碼。
location	string	資源的地理位置。
name	string	資源的名稱。
properties	ClusterResourceProperties	服務資源的屬性
sku	Sku	服務資源的 SKU
systemData	SystemData	與建立和上次修改資源相關的元數據。
tags	object	服務的標記，這是描述資源的索引鍵值組清單。
type	string	資源的型別。

ServiceResourceList

Object

物件，其中包含服務資源的陣列，以及下一個集合的可能連結

名稱	類型	Description
nextLink	string	URL 用戶端應該使用來擷取下一頁（每一伺服器端分頁）。目前為 Null，已新增以供日後使用。
value	ServiceResource[]	服務資源的集合

ServiceVNetAddons

Object

vnet 插入實例中的其他服務設定

名稱	類型	預設值	Description
dataPlanePublicEndpoint	boolean	False	指出是否可以從因特網存取 vnet 插入實例中的數據平面元件（記錄數據流、應用程式連線、遠端偵錯）。
logStreamPublicEndpoint	boolean	False	指出是否可以從因特網存取 vnet 插入實例中的記錄數據流。

Sku

Object

Azure Spring Apps 的 SKU

名稱	類型	預設值	Description
capacity	integer (int32)		目標資源的目前容量
name	string	S0	Sku 的名稱
tier	string	Standard	Sku 的階層

SystemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源修改的時間戳（UTC）。
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	lastModifiedByType	上次修改資源的身分識別類型。

trafficDirection

列舉型別

所需流量的方向

值	Description
Inbound
Outbound

共用方式為

Services - List

URI 參數

回應

安全性

azure_auth

範圍

範例

Services_List

範例要求

範例回覆

定義

CloudError

CloudErrorBody

ClusterResourceProperties

createdByType

IngressConfig

lastModifiedByType

MarketplaceResource

NetworkProfile

OutboundIPs

PowerState

ProvisioningState

RequiredTraffic

ServiceResource

ServiceResourceList

ServiceVNetAddons

Sku

SystemData

trafficDirection