Build Service Builder - Create Or Update

Reference

Service:: Azure Spring Apps

API Version:: 2023-12-01

Vytvořte nebo aktualizujte tvůrce KPack.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
builderName	path	True	string	Název prostředku tvůrce.
buildServiceName	path	True	string	Název prostředku služby sestavení.
resourceGroupName	path	True	string	Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
serviceName	path	True	string	Název prostředku služby. Regex pattern: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	Získá ID předplatného, které jednoznačně identifikuje předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties	BuilderProperties	Vlastnost prostředku Tvůrce.

Odpovědi

Name	Typ	Description
200 OK	BuilderResource	Úspěch. Odpověď popisuje Tvůrce.
201 Created	BuilderResource	Vytvořen. Odpověď popisuje nového Tvůrce a obsahuje hlavičku Azure-AsyncOperation pro dotaz na výsledek operace.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
BuilderProperties	Datová část vlastností KPack Builderu
BuilderProvisioningState	Stav zřizování tvůrce.
BuilderResource	Prostředek KPack Builderu
BuildpackProperties	Datová část vlastností buildpacku
BuildpacksGroupProperties	Vlastnosti skupiny Buildpack tvůrce
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
createdByType	Typ identity, která prostředek vytvořila.
lastModifiedByType	Typ identity, která naposledy změnila prostředek.
StackProperties	Datová část vlastností clusteru KPack
SystemData	Metadata týkající se vytvoření a poslední změny prostředku.

BuilderProperties

Datová část vlastností KPack Builderu

Name	Typ	Description
buildpackGroups	BuildpacksGroupProperties[]	Skupiny buildpacků v Tvůrci
provisioningState	BuilderProvisioningState	Stav zřizování tvůrce.
stack	StackProperties	Vlastnost zásobníku clusteru tvůrce

BuilderProvisioningState

Stav zřizování tvůrce.

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

BuilderResource

Prostředek KPack Builderu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku.
name	string	Název prostředku.
properties	BuilderProperties	Vlastnost prostředku Tvůrce.
systemData	SystemData	Metadata týkající se vytvoření a poslední změny prostředku.
type	string	Typ prostředku.

BuildpackProperties

Datová část vlastností buildpacku

Name	Typ	Description
id	string	ID buildpacku

BuildpacksGroupProperties

Vlastnosti skupiny Buildpack tvůrce

Name	Typ	Description
buildpacks	BuildpackProperties[]	Buildpacks ve skupině buildpack
name	string	Název skupiny buildpacku

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď ze služby.

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

Typ identity, která naposledy změnila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

StackProperties

Datová část vlastností clusteru KPack

Name	Typ	Description
id	string	Id of the ClusterStack.
version	string	Verze ClusterStacku

SystemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	lastModifiedByType	Typ identity, která naposledy změnila prostředek.

Build Service Builder - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

BuildServiceBuilder_CreateOrUpdate

Sample Request

Sample Response

Definice

BuilderProperties

BuilderProvisioningState

BuilderResource

BuildpackProperties

BuildpacksGroupProperties

CloudError

CloudErrorBody

createdByType

lastModifiedByType

StackProperties

SystemData

Další materiály