Build Service Builder - Get

Servizio:

Azure Spring Apps

Versione API:

2023-12-01

Ottenere un generatore KPack.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
builderName	path	True	string	Nome della risorsa del generatore.
buildServiceName	path	True	string	Nome della risorsa del servizio di compilazione.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Nome della risorsa del servizio.
subscriptionId	path	True	string	Ottiene l'ID sottoscrizione che identifica in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	BuilderResource	Successo. La risposta descrive il generatore
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

BuildServiceBuilder_Get

Esempio di richiesta

HTTP

GET 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

Java

/**
 * Samples for BuildServiceBuilder Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * BuildServiceBuilder_Get.json
     */
    /**
     * Sample code: BuildServiceBuilder_Get.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void buildServiceBuilderGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getBuildServiceBuilders().getWithResponse("myResourceGroup",
            "myservice", "default", "mybuilder", 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

Python

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_get.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.get(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        build_service_name="default",
        builder_name="mybuilder",
    )
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_Get.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

Go

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_Get.json
func ExampleBuildServiceBuilderClient_Get() {
	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)
	}
	res, err := clientFactory.NewBuildServiceBuilderClient().Get(ctx, "myResourceGroup", "myservice", "default", "mybuilder", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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"),
	// 				}},
	// 		}},
	// 		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

JavaScript

const { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a KPack builder.
 *
 * @summary Get a KPack builder.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildServiceBuilder_Get.json
 */
async function buildServiceBuilderGet() {
  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 credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.buildServiceBuilder.get(
    resourceGroupName,
    serviceName,
    buildServiceName,
    builderName,
  );
  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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
BuilderProperties	Payload delle proprietà di KPack Builder
BuilderProvisioningState	Stato del provisioning del generatore.
BuilderResource	Risorsa KPack Builder
BuildpackProperties	Payload delle proprietà buildpack
BuildpacksGroupProperties	Proprietà del gruppo Buildpack di Builder
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedByType	Tipo di identità che ha modificato l'ultima volta la risorsa.
StackProperties	Payload delle proprietà cluster KPack
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

BuilderProperties

Oggetto

Payload delle proprietà di KPack Builder

Nome	Tipo	Descrizione
buildpackGroups	BuildpacksGroupProperties[]	Generatore di gruppi buildpack.
provisioningState	BuilderProvisioningState	Stato del provisioning del generatore.
stack	StackProperties	Proprietà dello stack di cluster builder.

BuilderProvisioningState

Enumerazione

Stato del provisioning del generatore.

Valore	Descrizione
Creating
Updating
Succeeded
Failed
Deleting

BuilderResource

Oggetto

Risorsa KPack Builder

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa.
name	string	Nome della risorsa.
properties	BuilderProperties	Proprietà della risorsa Builder.
systemData	SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo della risorsa.

BuildpackProperties

Oggetto

Payload delle proprietà buildpack

Nome	Tipo	Descrizione
id	string	ID del buildpack

BuildpacksGroupProperties

Oggetto

Proprietà del gruppo Buildpack di Builder

Nome	Tipo	Descrizione
buildpacks	BuildpackProperties[]	Buildpack nel gruppo buildpack
name	string	Nome gruppo Buildpack

CloudError

Oggetto

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore dal servizio.

CloudErrorBody

Oggetto

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

lastModifiedByType

Enumerazione

Tipo di identità che ha modificato l'ultima volta la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

StackProperties

Oggetto

Payload delle proprietà cluster KPack

Nome	Tipo	Descrizione
id	string	ID di ClusterStack.
version	string	Versione di ClusterStack

SystemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp della modifica della risorsa (UTC).
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	lastModifiedByType	Tipo di identità che ha modificato l'ultima volta la risorsa.