Build Service Builder - List

Szolgáltatás:: Azure Spring Apps

API-verzió:: 2023-12-01

A KPack-szerkesztők eredményeinek listázása.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
buildServiceName	path	True	string	A buildszolgáltatás-erőforrás neve.
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	A szolgáltatáserőforrás neve.
subscriptionId	path	True	string	Lekéri az előfizetés azonosítóját, amely egyedileg azonosítja a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	BuilderResourceCollection	Siker. A válasz leírja a szerkesztőlistát
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

BuildServiceBuilder_List

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
}

Definíciók

Name	Description
BuilderProperties	A KPack Builder tulajdonságainak hasznos adatai
BuilderProvisioningState	A builder kiépítési állapota.
BuilderResource	KPack Builder-erőforrás
BuilderResourceCollection	A Builder-erőforrások tömbje és a következő készlet lehetséges hivatkozását tartalmazó objektum
BuildpackProperties	A Buildpack tulajdonságainak hasznos adatai
BuildpacksGroupProperties	A Builder Buildpack-csoporttulajdonságai
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedByType	Az erőforrást legutóbb módosító identitás típusa.
StackProperties	A KPack ClusterStack tulajdonságainak hasznos adatai
SystemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

BuilderProperties

Objektum

A KPack Builder tulajdonságainak hasznos adatai

Name	Típus	Description
buildpackGroups	BuildpacksGroupProperties[]	Builder buildpack-csoportok.
provisioningState	BuilderProvisioningState	A builder kiépítési állapota.
stack	StackProperties	Fürt veremtulajdonságának létrehozása.

BuilderProvisioningState

Enumerálás

A builder kiépítési állapota.

Érték	Description
Creating
Deleting
Failed
Succeeded
Updating

BuilderResource

Objektum

KPack Builder-erőforrás

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója.
name	string	Az erőforrás neve.
properties	BuilderProperties	A Builder-erőforrás tulajdonsága.
systemData	SystemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa.

BuilderResourceCollection

Objektum

A Builder-erőforrások tömbje és a következő készlet lehetséges hivatkozását tartalmazó objektum

Name	Típus	Description
nextLink	string	Az URL-ügyfélnek a következő lap lekérésére kell használnia (kiszolgálóoldali lapozásonként). Egyelőre null értékű, későbbi használatra hozzáadva.
value	BuilderResource[]	Builder-erőforrások gyűjteménye

BuildpackProperties

Objektum

A Buildpack tulajdonságainak hasznos adatai

Name	Típus	Description
id	string	A buildpack azonosítója

BuildpacksGroupProperties

Objektum

A Builder Buildpack-csoporttulajdonságai

Name	Típus	Description
buildpacks	BuildpackProperties[]	Buildpacks a buildpack csoportban
name	string	Buildpack-csoport neve

CloudError

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Hibaválasz a szolgáltatástól.

CloudErrorBody

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

lastModifiedByType

Enumerálás

Az erőforrást legutóbb módosító identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

StackProperties

Objektum

A KPack ClusterStack tulajdonságainak hasznos adatai

Name	Típus	Description
id	string	A ClusterStack azonosítója.
version	string	A ClusterStack verziója

SystemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás-módosítás időbélyege (UTC).
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	lastModifiedByType	Az erőforrást legutóbb módosító identitás típusa.

Megosztás a következőn keresztül:

Build Service Builder - List

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

BuildServiceBuilder_List

Mintakérelem

Mintaválasz

Definíciók

BuilderProperties

BuilderProvisioningState

BuilderResource

BuilderResourceCollection

BuildpackProperties

BuildpacksGroupProperties

CloudError

CloudErrorBody

createdByType

lastModifiedByType

StackProperties

SystemData