Build Service Builder - List

Ссылка

Service:: Azure Spring Apps

API Version:: 2023-12-01

Вывод списка результатов построителей KPack.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
buildServiceName	path	True	string	Имя ресурса службы сборки.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serviceName	path	True	string	Имя ресурса службы. Regex pattern: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	Возвращает идентификатор подписки, который однозначно идентифицирует подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	BuilderResourceCollection	Успешно. В ответе описывается список построителя
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

BuildServiceBuilder_List

Sample Request

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


/**
 * Samples for BuildServiceBuilder List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * BuildServiceBuilder_List.json
     */
    /**
     * Sample code: BuildServiceBuilder_List.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void buildServiceBuilderList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getBuildServiceBuilders().list("myResourceGroup", "myservice",
            "default", 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_builder_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.build_service_builder.list(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        build_service_name="default",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_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/BuildServiceBuilder_List.json
func ExampleBuildServiceBuilderClient_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.NewBuildServiceBuilderClient().NewListPager("myResourceGroup", "myservice", "default", 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.BuilderResourceCollection = armappplatform.BuilderResourceCollection{
		// 	Value: []*armappplatform.BuilderResource{
		// 		{
		// 			Name: to.Ptr("mybuilder"),
		// 			Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder"),
		// 			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.BuilderProperties{
		// 				BuildpackGroups: []*armappplatform.BuildpacksGroupProperties{
		// 					{
		// 						Name: to.Ptr("mix"),
		// 						Buildpacks: []*armappplatform.BuildpackProperties{
		// 							{
		// 								ID: to.Ptr("tanzu-buildpacks/java-azure"),
		// 						}},
		// 				}},
		// 				ProvisioningState: to.Ptr(armappplatform.BuilderProvisioningStateSucceeded),
		// 				Stack: &armappplatform.StackProperties{
		// 					ID: to.Ptr("io.buildpacks.stacks.bionic"),
		// 					Version: to.Ptr("base"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 KPack builders result.
 *
 * @summary List KPack builders result.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_List.json
 */
async function buildServiceBuilderList() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const buildServiceName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.buildServiceBuilder.list(
    resourceGroupName,
    serviceName,
    buildServiceName,
  )) {
    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": {
        "provisioningState": "Succeeded",
        "stack": {
          "id": "io.buildpacks.stacks.bionic",
          "version": "base"
        },
        "buildpackGroups": [
          {
            "name": "mix",
            "buildpacks": [
              {
                "id": "tanzu-buildpacks/java-azure"
              }
            ]
          }
        ]
      },
      "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/builders",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/mybuilder",
      "name": "mybuilder"
    }
  ],
  "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders?$page=2"
}

Определения

Имя	Описание
BuilderProperties	Полезные данные свойств Построителя KPack
BuilderProvisioningState	Состояние подготовки построителя.
BuilderResource	Ресурс KPack Builder
BuilderResourceCollection	Объект , включающий массив ресурсов построителя и возможную ссылку для следующего набора
BuildpackProperties	Полезные данные свойств пакета сборки
BuildpacksGroupProperties	Свойства группы пакета сборки построителя
CloudError	Ответ об ошибке от службы.
CloudErrorBody	Ответ об ошибке от службы.
createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedByType	Тип удостоверения, которое последним изменял ресурс.
StackProperties	Полезные данные свойств KPack ClusterStack
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.

BuilderProperties

Полезные данные свойств Построителя KPack

Имя	Тип	Описание
buildpackGroups	BuildpacksGroupProperties[]	Группы пакетов сборки построителя.
provisioningState	BuilderProvisioningState	Состояние подготовки построителя.
stack	StackProperties	Свойство стека кластера построителя.

BuilderProvisioningState

Состояние подготовки построителя.

Имя	Тип	Описание
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

BuilderResource

Ресурс KPack Builder

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса.
name	string	Имя ресурса.
properties	BuilderProperties	Свойство ресурса Builder.
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
type	string	Тип ресурса.

BuilderResourceCollection

Объект , включающий массив ресурсов построителя и возможную ссылку для следующего набора

Имя	Тип	Описание
nextLink	string	URL-клиент должен использовать для получения следующей страницы (для разбиения по страницам на стороне сервера). На данный момент он имеет значение NULL, добавленный для использования в будущем.
value	BuilderResource[]	Коллекция ресурсов построителя

BuildpackProperties

Полезные данные свойств пакета сборки

Имя	Тип	Описание
id	string	Идентификатор пакета сборки

BuildpacksGroupProperties

Свойства группы пакета сборки построителя

Имя	Тип	Описание
buildpacks	BuildpackProperties[]	Пакеты сборок в группе пакетов сборки
name	string	Имя группы пакета сборки

CloudError

Ответ об ошибке от службы.

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от службы.

CloudErrorBody

Ответ об ошибке от службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

Тип удостоверения, которое последним изменял ресурс.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

StackProperties

Полезные данные свойств KPack ClusterStack

Имя	Тип	Описание
id	string	Идентификатор ClusterStack.
version	string	Версия ClusterStack

SystemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени изменения ресурса (UTC).
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	lastModifiedByType	Тип удостоверения, которое последним изменял ресурс.

Build Service Builder - List

Параметры URI

Ответы

Безопасность

azure_auth

Scopes

Примеры

BuildServiceBuilder_List

Sample Request

Sample Response

Определения

BuilderProperties

BuilderProvisioningState

BuilderResource

BuilderResourceCollection

BuildpackProperties

BuildpacksGroupProperties

CloudError

CloudErrorBody

createdByType

lastModifiedByType

StackProperties

SystemData

Дополнительные ресурсы