Build Service Builder - Create Or Update

Referens

Service:: Azure Spring Apps

API Version:: 2023-12-01

Skapa eller uppdatera en KPack-byggare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
builderName	path	True	string	Namnet på byggarresursen.
buildServiceName	path	True	string	Namnet på byggtjänstresursen.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serviceName	path	True	string	Namnet på tjänstresursen. Regex pattern: `^[a-z][a-z0-9-]*[a-z0-9]$`
subscriptionId	path	True	string	Hämtar prenumerations-ID som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties	BuilderProperties	Egenskapen för Builder-resursen.

Svar

Name	Typ	Description
200 OK	BuilderResource	Åtgärden lyckades. Svaret beskriver Builder
201 Created	BuilderResource	Skapad. Svaret beskriver det nya builder-objektet och innehåller ett Azure-AsyncOperation-huvud för att köra frågor mot åtgärdsresultatet.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
BuilderProperties	Nyttolast för KPack Builder-egenskaper
BuilderProvisioningState	Etableringsstatus för builder.
BuilderResource	KPack Builder-resurs
BuildpackProperties	Nyttolast för Buildpack-egenskaper
BuildpacksGroupProperties	Buildpack-gruppegenskaper för builder
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
createdByType	Den typ av identitet som skapade resursen.
lastModifiedByType	Den typ av identitet som senast ändrade resursen.
StackProperties	Nyttolast för KPack ClusterStack-egenskaper
SystemData	Metadata som rör skapande och senaste ändring av resursen.

BuilderProperties

Nyttolast för KPack Builder-egenskaper

Name	Typ	Description
buildpackGroups	BuildpacksGroupProperties[]	Builder buildpack-grupper.
provisioningState	BuilderProvisioningState	Etableringsstatus för builder.
stack	StackProperties	Stackegenskap för builder-kluster.

BuilderProvisioningState

Etableringsstatus för builder.

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

BuilderResource

KPack Builder-resurs

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen.
name	string	Namnet på resursen.
properties	BuilderProperties	Egenskapen för Builder-resursen.
systemData	SystemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Resurstypen.

BuildpackProperties

Nyttolast för Buildpack-egenskaper

Name	Typ	Description
id	string	ID för buildpack

BuildpacksGroupProperties

Buildpack-gruppegenskaper för builder

Name	Typ	Description
buildpacks	BuildpackProperties[]	Buildpacks i buildpack-gruppen
name	string	Buildpack-gruppnamn

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från tjänsten.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

lastModifiedByType

Den typ av identitet som senast ändrade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

StackProperties

Nyttolast för KPack ClusterStack-egenskaper

Name	Typ	Description
id	string	ID för ClusterStack.
version	string	Version av ClusterStack

SystemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursändring (UTC).
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	lastModifiedByType	Den typ av identitet som senast ändrade resursen.

Build Service Builder - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Scopes

Exempel

BuildServiceBuilder_CreateOrUpdate

Sample Request

Sample Response

Definitioner

BuilderProperties

BuilderProvisioningState

BuilderResource

BuildpackProperties

BuildpacksGroupProperties

CloudError

CloudErrorBody

createdByType

lastModifiedByType

StackProperties

SystemData

Ytterligare resurser