Build Service - Get Build Service

Servicio:

Azure Spring Apps

Versión de la API:

2023-12-01

Obtenga un recurso de servicio de compilación.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
buildServiceName	path	True	string	Nombre del recurso del servicio de compilación.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Nombre del recurso de servicio.
subscriptionId	path	True	string	Obtiene el identificador de suscripción que identifica de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	BuildService	Éxito. La respuesta describe el servicio de compilación.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

BuildService_GetBuildService

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for BuildService GetBuildService.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * BuildService_GetBuildService.json
     */
    /**
     * Sample code: BuildService_GetBuildService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void buildServiceGetBuildService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getBuildServices()
            .getBuildServiceWithResponse("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

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_get_build_service.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.get_build_service(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        build_service_name="default",
    )
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetBuildService.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/BuildService_GetBuildService.json
func ExampleBuildServiceClient_GetBuildService() {
	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.NewBuildServiceClient().GetBuildService(ctx, "myResourceGroup", "myservice", "default", 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.BuildService = armappplatform.BuildService{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default"),
	// 	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.BuildServiceProperties{
	// 		KPackVersion: to.Ptr("0.3.1"),
	// 		ProvisioningState: to.Ptr(armappplatform.BuildServiceProvisioningStateSucceeded),
	// 		ResourceRequests: &armappplatform.BuildServicePropertiesResourceRequests{
	// 			CPU: to.Ptr("200m"),
	// 			Memory: to.Ptr("4Gi"),
	// 		},
	// 	},
	// }
}

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 build service resource.
 *
 * @summary Get a build service resource.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_GetBuildService.json
 */
async function buildServiceGetBuildService() {
  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 result = await client.buildServiceOperations.getBuildService(
    resourceGroupName,
    serviceName,
    buildServiceName,
  );
  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

Respuesta de muestra

status code:

200

{
  "properties": {
    "kPackVersion": "0.3.1",
    "provisioningState": "Succeeded",
    "resourceRequests": {
      "cpu": "200m",
      "memory": "4Gi"
    }
  },
  "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",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default",
  "name": "default"
}

Definiciones

Nombre	Description
BuildService	Carga de recursos del servicio de compilación
BuildServiceProperties	Carga de las propiedades de recursos del servicio de compilación
BuildServiceProvisioningState	Estado de aprovisionamiento del servicio de compilación KPack
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
createdByType	Tipo de identidad que creó el recurso.
lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.
ResourceRequests	Carga de solicitud de recursos de implementación
SystemData	Metadatos relativos a la creación y última modificación del recurso.

BuildService

Object

Carga de recursos del servicio de compilación

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso.
name	string	Nombre del recurso.
properties	BuildServiceProperties	Propiedades del recurso de compilación
systemData	SystemData	Metadatos relativos a la creación y última modificación del recurso.
type	string	Tipo del recurso.

BuildServiceProperties

Object

Carga de las propiedades de recursos del servicio de compilación

Nombre	Tipo	Description
containerRegistry	string	Identificador de recurso del registro de contenedor usado en este servicio de compilación.
kPackVersion	string	La versión KPack instalada en este servicio de compilación.
provisioningState	BuildServiceProvisioningState	Estado de aprovisionamiento del servicio de compilación KPack
resourceRequests	ResourceRequests	Configuración de recursos en tiempo de ejecución de este servicio de compilación.

BuildServiceProvisioningState

Enumeración

Estado de aprovisionamiento del servicio de compilación KPack

Valor	Description
Creating
Deleting
Failed
Succeeded
Updating

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del servicio.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

lastModifiedByType

Enumeración

Tipo de identidad que modificó por última vez el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ResourceRequests

Object

Carga de solicitud de recursos de implementación

Nombre	Tipo	Description
cpu	string	CPU necesaria. 1 núcleo se puede representar mediante 1 o 1000m. Debe ser de 500 m o 1 para el nivel Básico y {500m, 1, 2, 3, 4} para el nivel Estándar.
memory	string	Memoria necesaria. 1 GB se puede representar mediante 1Gi o 1024Mi. Debe ser {512Mi, 1Gi, 2Gi} para el nivel Básico y {512Mi, 1Gi, 2Gi, ..., 8Gi} para el nivel Estándar.

SystemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de modificación de recursos (UTC).
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.