Build Service - List Build Services

Başvuru

Service:: Azure Spring Apps

API Version:: 2023-12-01

Derleme hizmetleri kaynağını listeleme.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynağı içeren kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
serviceName	path	True	string	Hizmet kaynağının adı. Regex pattern: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimliğini alır. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	BuildServiceCollection	Başarılı. Yanıt, Derleme Hizmetleri'ni açıklar.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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"
}

Tanımlar

Name	Description
BuildService	Hizmet kaynağı yükü oluşturma
BuildServiceCollection	Derleme hizmeti kaynakları dizisi ve sonraki küme için olası bir bağlantı içeren nesne
BuildServiceProperties	Derleme hizmeti kaynak özellikleri yükü
BuildServiceProvisioningState	KPack derleme hizmetinin sağlama durumu
CloudError	Hizmetten bir hata yanıtı.
CloudErrorBody	Hizmetten bir hata yanıtı.
createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedByType	Kaynağı en son değiştiren kimliğin türü.
ResourceRequests	Dağıtım kaynak isteği yükü
SystemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

BuildService

Hizmet kaynağı yükü oluşturma

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği.
name	string	Kaynağın adı.
properties	BuildServiceProperties	Derleme kaynağının özellikleri
systemData	SystemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
type	string	Kaynağın türü.

BuildServiceCollection

Derleme hizmeti kaynakları dizisi ve sonraki küme için olası bir bağlantı içeren nesne

Name	Tür	Description
nextLink	string	URL istemcisi sonraki sayfayı getirmek için kullanmalıdır (sunucu tarafı sayfalama başına). Şimdilik null, gelecekte kullanmak üzere eklendi.
value	BuildService[]	Derleme hizmeti kaynaklarının toplanması

BuildServiceProperties

Derleme hizmeti kaynak özellikleri yükü

Name	Tür	Description
containerRegistry	string	Bu derleme hizmetinde kullanılan kapsayıcı kayıt defterinin kaynak kimliği.
kPackVersion	string	Bu derleme hizmetinde yüklü KPack sürümü.
provisioningState	BuildServiceProvisioningState	KPack derleme hizmetinin sağlama durumu
resourceRequests	ResourceRequests	Bu derleme hizmetinin çalışma zamanı kaynak yapılandırması.

BuildServiceProvisioningState

KPack derleme hizmetinin sağlama durumu

Name	Tür	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

CloudError

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	CloudErrorBody	Hizmetten bir hata yanıtı.

CloudErrorBody

Hizmetten bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
target	string	Belirli bir hatanın hedefi. Örneğin, özelliğin adı hatalı.

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

Kaynağı en son değiştiren kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ResourceRequests

Dağıtım kaynak isteği yükü

Name	Tür	Description
cpu	string	Gerekli CPU. 1 çekirdek 1 veya 1000m ile temsil edilebilir. Bu, Temel katman için 500m veya 1, Standart katman için {500m, 1, 2, 3, 4} olmalıdır.
memory	string	Gerekli bellek. 1 GB, 1Gi veya 1024Mi ile temsil edilebilir. Bu, Temel katman için {512Mi, 1Gi, 2Gi} ve Standart katman için {512Mi, 1Gi, 2Gi, ..., 8Gi} olmalıdır.

SystemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynak değişikliğinin zaman damgası (UTC).
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	lastModifiedByType	Kaynağı en son değiştiren kimliğin türü.

Build Service - List Build Services

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

BuildService_ListBuildServices

Sample Request

Sample Response

Tanımlar

BuildService

BuildServiceCollection

BuildServiceProperties

BuildServiceProvisioningState

CloudError

CloudErrorBody

createdByType

lastModifiedByType

ResourceRequests

SystemData

Ek kaynaklar