Build Service - List Build Services

참조

Service:: Azure Spring Apps

API Version:: 2023-12-01

빌드 서비스 리소스를 나열합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
serviceName	path	True	string	서비스 리소스의 이름입니다. Regex pattern: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 ID를 가져옵니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	BuildServiceCollection	성공. 응답은 Build Services에 대해 설명합니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

BuildService_ListBuildServices

Sample Request

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


/**
 * Samples for BuildService ListBuildServices.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * BuildService_ListBuildServices.json
     */
    /**
     * Sample code: BuildService_ListBuildServices.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void buildServiceListBuildServices(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getBuildServices().listBuildServices("myResourceGroup",
            "myservice", 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 build_service_list_build_services.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.build_service.list_build_services(
        resource_group_name="myResourceGroup",
        service_name="myservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListBuildServices.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/BuildService_ListBuildServices.json
func ExampleBuildServiceClient_NewListBuildServicesPager() {
	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.NewBuildServiceClient().NewListBuildServicesPager("myResourceGroup", "myservice", 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.BuildServiceCollection = armappplatform.BuildServiceCollection{
		// 	Value: []*armappplatform.BuildService{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default"),
		// 			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),
		// 			},
		// 			Properties: &armappplatform.BuildServiceProperties{
		// 				KPackVersion: to.Ptr("0.3.1"),
		// 				ProvisioningState: to.Ptr(armappplatform.BuildServiceProvisioningStateSucceeded),
		// 				ResourceRequests: &armappplatform.BuildServicePropertiesResourceRequests{
		// 					CPU: to.Ptr("200m"),
		// 					Memory: to.Ptr("4Gi"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 List build services resource.
 *
 * @summary List build services resource.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListBuildServices.json
 */
async function buildServiceListBuildServices() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.buildServiceOperations.listBuildServices(
    resourceGroupName,
    serviceName,
  )) {
    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

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "kPackVersion": "0.3.1",
        "provisioningState": "Succeeded",
        "resourceRequests": {
          "cpu": "200m",
          "memory": "4Gi"
        }
      },
      "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/buildServices",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default",
      "name": "default"
    }
  ],
  "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices?$page=2"
}

정의

Name	Description
BuildService	서비스 리소스 페이로드 빌드
BuildServiceCollection	빌드 서비스 리소스의 배열과 다음 집합에 대한 가능한 링크를 포함하는 개체
BuildServiceProperties	빌드 서비스 리소스 속성 페이로드
BuildServiceProvisioningState	KPack 빌드 서비스의 프로비전 상태
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
createdByType	리소스를 만든 ID 유형입니다.
lastModifiedByType	리소스를 마지막으로 수정한 ID 유형입니다.
ResourceRequests	배포 리소스 요청 페이로드
SystemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

BuildService

서비스 리소스 페이로드 빌드

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다.
name	string	리소스의 이름입니다.
properties	BuildServiceProperties	빌드 리소스의 속성
systemData	SystemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
type	string	리소스 형식입니다.

BuildServiceCollection

빌드 서비스 리소스의 배열과 다음 집합에 대한 가능한 링크를 포함하는 개체

Name	형식	Description
nextLink	string	URL 클라이언트는 를 사용하여 다음 페이지(서버 쪽 페이징당)를 페치해야 합니다. 지금은 null이며 나중에 사용할 수 있게 추가되었습니다.
value	BuildService[]	빌드 서비스 리소스 컬렉션

BuildServiceProperties

빌드 서비스 리소스 속성 페이로드

Name	형식	Description
containerRegistry	string	이 빌드 서비스에 사용되는 컨테이너 레지스트리의 리소스 ID입니다.
kPackVersion	string	이 빌드 서비스에 설치된 KPack 버전입니다.
provisioningState	BuildServiceProvisioningState	KPack 빌드 서비스의 프로비전 상태
resourceRequests	ResourceRequests	이 빌드 서비스의 런타임 리소스 구성입니다.

BuildServiceProvisioningState

KPack 빌드 서비스의 프로비전 상태

Name	형식	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	서비스의 오류 응답입니다.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

리소스를 마지막으로 수정한 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ResourceRequests

배포 리소스 요청 페이로드

Name	형식	Description
cpu	string	필수 CPU입니다. 코어 1개는 1 또는 1000m로 나타낼 수 있습니다. 기본 계층의 경우 500m 또는 1이고 표준 계층의 경우 {500m, 1, 2, 3, 4}이어야 합니다.
memory	string	필수 메모리입니다. 1GB는 1Gi 또는 1024Mi로 나타낼 수 있습니다. 기본 계층의 경우 {512Mi, 1Gi, 2Gi} 및 표준 계층의 경우 {512Mi, 1Gi, 2Gi, ..., 8Gi}이어야 합니다.

SystemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string	UTC(리소스 수정)의 타임스탬프입니다.
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	lastModifiedByType	리소스를 마지막으로 수정한 ID 유형입니다.

Build Service - List Build Services

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

BuildService_ListBuildServices

Sample Request

Sample Response

정의

BuildService

BuildServiceCollection

BuildServiceProperties

BuildServiceProvisioningState

CloudError

CloudErrorBody

createdByType

lastModifiedByType

ResourceRequests

SystemData

추가 리소스