Build Service - Get Build Service

Szolgáltatás:: Azure Spring Apps

API-verzió:: 2023-12-01

Buildszolgáltatás-erőforrás lekérése.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}?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	BuildService	Siker. A válasz a buildszolgáltatást írja le.
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

BuildService_GetBuildService

Mintakérelem

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


/**
 * 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

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

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

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

Mintaválasz

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

Definíciók

Name	Description
BuildService	Szolgáltatáserőforrás hasznos adatainak összeállítása
BuildServiceProperties	Szolgáltatáserőforrás-tulajdonságok hasznos adatainak összeállítása
BuildServiceProvisioningState	A KPack buildszolgáltatás kiépítési állapota
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.
ResourceRequests	Üzembehelyezési erőforrás-kérelem hasznos adatai
SystemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

BuildService

Objektum

Szolgáltatáserőforrás hasznos adatainak összeállítása

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	BuildServiceProperties	A builderőforrás tulajdonságai
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.

BuildServiceProperties

Objektum

Szolgáltatáserőforrás-tulajdonságok hasznos adatainak összeállítása

Name	Típus	Description
containerRegistry	string	A buildszolgáltatásban használt tárolóregisztrációs adatbázis erőforrás-azonosítója.
kPackVersion	string	A buildelési szolgáltatásban telepített KPack-verzió.
provisioningState	BuildServiceProvisioningState	A KPack buildszolgáltatás kiépítési állapota
resourceRequests	ResourceRequests	A buildelési szolgáltatás futtatókörnyezeti erőforrás-konfigurációja.

BuildServiceProvisioningState

Enumerálás

A KPack buildszolgáltatás kiépítési állapota

Érték	Description
Creating
Deleting
Failed
Succeeded
Updating

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

ResourceRequests

Objektum

Üzembehelyezési erőforrás-kérelem hasznos adatai

Name	Típus	Description
cpu	string	Szükséges processzor. Az 1 magot 1 vagy 1000m képviselheti. Ennek 500 m-nek vagy 1-nek kell lennie az alapszinthez, és {500m, 1, 2, 3, 4} standard szinthez.
memory	string	Szükséges memória. Az 1 GB-ot 1Gi vagy 1024Mi képviselheti. Ennek az alapszinthez {512Mi, 1Gi, 2Gi} és {512Mi, 1Gi, 2Gi, ..., 8Gi} kell lennie standard szinten.

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 - Get Build Service

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

BuildService_GetBuildService

Mintakérelem

Mintaválasz

Definíciók

BuildService

BuildServiceProperties

BuildServiceProvisioningState

CloudError

CloudErrorBody

createdByType

lastModifiedByType

ResourceRequests

SystemData