Build Service Builder - Create Or Update

Referência

Service:: Azure Spring Apps

API Version:: 2023-12-01

Criar ou atualizar um construtor de KPack.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
builderName	path	True	string	O nome do recurso do construtor.
buildServiceName	path	True	string	O nome do recurso do serviço de compilação.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serviceName	path	True	string	O nome do recurso do Serviço. Regex pattern: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	Obtém o ID da subscrição que identifica exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties	BuilderProperties	Propriedade do recurso Construtor.

Respostas

Name	Tipo	Description
200 OK	BuilderResource	Com êxito. A resposta descreve o Construtor
201 Created	BuilderResource	Criado. A resposta descreve o novo Construtor e contém um cabeçalho Azure-AsyncOperation para consultar o resultado da operação.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

BuildServiceBuilder_CreateOrUpdate

Sample Request

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

{
  "properties": {
    "stack": {
      "id": "io.buildpacks.stacks.bionic",
      "version": "base"
    },
    "buildpackGroups": [
      {
        "name": "mix",
        "buildpacks": [
          {
            "id": "tanzu-buildpacks/java-azure"
          }
        ]
      }
    ]
  }
}


import com.azure.resourcemanager.appplatform.fluent.models.BuilderResourceInner;
import com.azure.resourcemanager.appplatform.models.BuilderProperties;
import com.azure.resourcemanager.appplatform.models.BuildpackProperties;
import com.azure.resourcemanager.appplatform.models.BuildpacksGroupProperties;
import com.azure.resourcemanager.appplatform.models.StackProperties;
import java.util.Arrays;

/**
 * Samples for BuildServiceBuilder CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * BuildServiceBuilder_CreateOrUpdate.json
     */
    /**
     * Sample code: BuildServiceBuilder_CreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void buildServiceBuilderCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getBuildServiceBuilders().createOrUpdate("myResourceGroup",
            "myservice", "default", "mybuilder",
            new BuilderResourceInner().withProperties(new BuilderProperties()
                .withStack(new StackProperties().withId("io.buildpacks.stacks.bionic").withVersion("base"))
                .withBuildpackGroups(Arrays.asList(new BuildpacksGroupProperties().withName("mix")
                    .withBuildpacks(Arrays.asList(new BuildpackProperties().withId("tanzu-buildpacks/java-azure")))))),
            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_create_or_update.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.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        build_service_name="default",
        builder_name="mybuilder",
        builder_resource={
            "properties": {
                "buildpackGroups": [{"buildpacks": [{"id": "tanzu-buildpacks/java-azure"}], "name": "mix"}],
                "stack": {"id": "io.buildpacks.stacks.bionic", "version": "base"},
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_CreateOrUpdate.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/azcore/to"
	"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_CreateOrUpdate.json
func ExampleBuildServiceBuilderClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewBuildServiceBuilderClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "mybuilder", armappplatform.BuilderResource{
		Properties: &armappplatform.BuilderProperties{
			BuildpackGroups: []*armappplatform.BuildpacksGroupProperties{
				{
					Name: to.Ptr("mix"),
					Buildpacks: []*armappplatform.BuildpackProperties{
						{
							ID: to.Ptr("tanzu-buildpacks/java-azure"),
						}},
				}},
			Stack: &armappplatform.StackProperties{
				ID:      to.Ptr("io.buildpacks.stacks.bionic"),
				Version: to.Ptr("base"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BuilderResource = 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"),
	// 					},
	// 					{
	// 						ID: to.Ptr("tanzu-buildpacks/dotnet-core"),
	// 				}},
	// 		}},
	// 		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 Create or update a KPack builder.
 *
 * @summary Create or update a KPack builder.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_CreateOrUpdate.json
 */
async function buildServiceBuilderCreateOrUpdate() {
  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 builderName = "mybuilder";
  const builderResource = {
    properties: {
      buildpackGroups: [{ name: "mix", buildpacks: [{ id: "tanzu-buildpacks/java-azure" }] }],
      stack: { id: "io.buildpacks.stacks.bionic", version: "base" },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.buildServiceBuilder.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    buildServiceName,
    builderName,
    builderResource,
  );
  console.log(result);
}

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

{
  "properties": {
    "provisioningState": "Succeeded",
    "stack": {
      "id": "io.buildpacks.stacks.bionic",
      "version": "base"
    },
    "buildpackGroups": [
      {
        "name": "mix",
        "buildpacks": [
          {
            "id": "tanzu-buildpacks/java-azure"
          },
          {
            "id": "tanzu-buildpacks/dotnet-core"
          }
        ]
      }
    ]
  },
  "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"
}

Status code:: 201

{
  "properties": {
    "provisioningState": "Creating",
    "stack": {
      "id": "io.buildpacks.stacks.bionic",
      "version": "base"
    },
    "buildpackGroups": [
      {
        "name": "mix",
        "buildpacks": [
          {
            "id": "tanzu-buildpacks/java-azure"
          },
          {
            "id": "tanzu-buildpacks/dotnet-core"
          }
        ]
      }
    ]
  },
  "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"
}

Definições

Name	Description
BuilderProperties	Payload de propriedades do KPack Builder
BuilderProvisioningState	Estado de aprovisionamento do construtor.
BuilderResource	Recurso do KPack Builder
BuildpackProperties	Payload de propriedades do Buildpack
BuildpacksGroupProperties	Propriedades do grupo Buildpack do Construtor
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
createdByType	O tipo de identidade que criou o recurso.
lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.
StackProperties	Payload de propriedades do KPack ClusterStack
SystemData	Metadados relativos à criação e última modificação do recurso.

BuilderProperties

Payload de propriedades do KPack Builder

Name	Tipo	Description
buildpackGroups	BuildpacksGroupProperties[]	Grupos buildpack do construtor.
provisioningState	BuilderProvisioningState	Estado de aprovisionamento do construtor.
stack	StackProperties	Propriedade de pilha de cluster do construtor.

BuilderProvisioningState

Estado de aprovisionamento do construtor.

Name	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

BuilderResource

Recurso do KPack Builder

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso.
name	string	O nome do recurso.
properties	BuilderProperties	Propriedade do recurso Construtor.
systemData	SystemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso.

BuildpackProperties

Payload de propriedades do Buildpack

Name	Tipo	Description
id	string	ID do buildpack

BuildpacksGroupProperties

Propriedades do grupo Buildpack do Construtor

Name	Tipo	Description
buildpacks	BuildpackProperties[]	Buildpacks no grupo buildpack
name	string	Nome do grupo buildpack

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

StackProperties

Payload de propriedades do KPack ClusterStack

Name	Tipo	Description
id	string	ID do ClusterStack.
version	string	Versão do ClusterStack

SystemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da modificação de recursos (UTC).
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.

Build Service Builder - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Scopes

Exemplos

BuildServiceBuilder_CreateOrUpdate

Sample Request

Sample Response

Definições

BuilderProperties

BuilderProvisioningState

BuilderResource

BuildpackProperties

BuildpacksGroupProperties

CloudError

CloudErrorBody

createdByType

lastModifiedByType

StackProperties

SystemData

Recursos adicionais