Build Service Builder - List

Servicio:: Azure Spring Apps

Versión de la API:: 2023-12-01

Enumerar el resultado de los generadores de KPack.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
buildServiceName	path	True	string	Nombre del recurso del servicio de compilación.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Nombre del recurso de servicio.
subscriptionId	path	True	string	Obtiene el identificador de suscripción que identifica de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	BuilderResourceCollection	Éxito. La respuesta describe la lista de generadores.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

BuildServiceBuilder_List

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
BuilderProperties	Carga útil de las propiedades de KPack Builder
BuilderProvisioningState	Estado de aprovisionamiento del generador.
BuilderResource	Recurso KPack Builder
BuilderResourceCollection	Objeto que incluye una matriz de recursos del Generador y un vínculo posible para el siguiente conjunto
BuildpackProperties	Carga útil de las propiedades buildpack
BuildpacksGroupProperties	Propiedades del grupo Buildpack del Generador
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
createdByType	Tipo de identidad que creó el recurso.
lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.
StackProperties	Carga de las propiedades de ClusterStack de KPack
SystemData	Metadatos relativos a la creación y última modificación del recurso.

BuilderProperties

Object

Carga útil de las propiedades de KPack Builder

Nombre	Tipo	Description
buildpackGroups	BuildpacksGroupProperties[]	Grupos buildpack del generador.
provisioningState	BuilderProvisioningState	Estado de aprovisionamiento del generador.
stack	StackProperties	Propiedad de pila del clúster del generador.

BuilderProvisioningState

Enumeración

Estado de aprovisionamiento del generador.

Valor	Description
Creating
Deleting
Failed
Succeeded
Updating

BuilderResource

Object

Recurso KPack Builder

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso.
name	string	Nombre del recurso.
properties	BuilderProperties	Propiedad del recurso Builder.
systemData	SystemData	Metadatos relativos a la creación y última modificación del recurso.
type	string	Tipo del recurso.

BuilderResourceCollection

Object

Objeto que incluye una matriz de recursos del Generador y un vínculo posible para el siguiente conjunto

Nombre	Tipo	Description
nextLink	string	El cliente de dirección URL debe usar para capturar la página siguiente (por paginación del lado servidor). Es null por ahora, agregado para su uso futuro.
value	BuilderResource[]	Colección de recursos del Generador

BuildpackProperties

Object

Carga útil de las propiedades buildpack

Nombre	Tipo	Description
id	string	Id. del paquete de compilación

BuildpacksGroupProperties

Object

Propiedades del grupo Buildpack del Generador

Nombre	Tipo	Description
buildpacks	BuildpackProperties[]	Buildpacks en el grupo buildpack
name	string	Nombre del grupo buildpack

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del servicio.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

lastModifiedByType

Enumeración

Tipo de identidad que modificó por última vez el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

StackProperties

Object

Carga de las propiedades de ClusterStack de KPack

Nombre	Tipo	Description
id	string	Identificador de ClusterStack.
version	string	Versión de ClusterStack

SystemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de modificación de recursos (UTC).
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Build Service Builder - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

BuildServiceBuilder_List

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BuilderProperties

BuilderProvisioningState

BuilderResource

BuilderResourceCollection

BuildpackProperties

BuildpacksGroupProperties

CloudError

CloudErrorBody

createdByType

lastModifiedByType

StackProperties

SystemData