Build Service - List Build Services

Service:: Azure Spring Apps

API-versie:: 2023-12-01

Maak een lijst met buildservicesresources.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	De naam van de serviceresource.
subscriptionId	path	True	string	Hiermee haalt u de abonnements-id op waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	BuildServiceCollection	Succes. In het antwoord worden de buildservices beschreven.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

BuildService_ListBuildServices

Voorbeeldaanvraag

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


/**
 * Samples for BuildService ListBuildServices.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * BuildService_ListBuildServices.json
     */
    /**
     * Sample code: BuildService_ListBuildServices.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void buildServiceListBuildServices(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getBuildServices().listBuildServices("myResourceGroup",
            "myservice", 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_list_build_services.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.list_build_services(
        resource_group_name="myResourceGroup",
        service_name="myservice",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListBuildServices.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_ListBuildServices.json
func ExampleBuildServiceClient_NewListBuildServicesPager() {
	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.NewBuildServiceClient().NewListBuildServicesPager("myResourceGroup", "myservice", 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.BuildServiceCollection = armappplatform.BuildServiceCollection{
		// 	Value: []*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 List build services resource.
 *
 * @summary List build services resource.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildService_ListBuildServices.json
 */
async function buildServiceListBuildServices() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.buildServiceOperations.listBuildServices(
    resourceGroupName,
    serviceName,
  )) {
    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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "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"
    }
  ],
  "nextLink": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices?$page=2"
}

Definities

Name	Description
BuildService	Nettolading van serviceresource bouwen
BuildServiceCollection	Object met een matrix van Build-servicebronnen en een mogelijke koppeling voor de volgende set
BuildServiceProperties	Nettolading serviceresource-eigenschappen bouwen
BuildServiceProvisioningState	Inrichtingsstatus van de KPack-buildservice
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.
ResourceRequests	Nettolading implementatieresourceaanvraag
SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

BuildService

Object

Nettolading van serviceresource bouwen

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource.
name	string	De naam van de resource.
properties	BuildServiceProperties	Eigenschappen van de buildresource
systemData	SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
type	string	Het type resource.

BuildServiceCollection

Object

Object met een matrix van Build-servicebronnen en een mogelijke koppeling voor de volgende set

Name	Type	Description
nextLink	string	URL-client moet worden gebruikt om de volgende pagina op te halen (paging aan de serverzijde). Het is nu null, toegevoegd voor toekomstig gebruik.
value	BuildService[]	Verzameling buildservicebronnen

BuildServiceProperties

Object

Nettolading serviceresource-eigenschappen bouwen

Name	Type	Description
containerRegistry	string	De resource-id van het containerregister dat in deze buildservice wordt gebruikt.
kPackVersion	string	De geïnstalleerde KPack-versie in deze buildservice.
provisioningState	BuildServiceProvisioningState	Inrichtingsstatus van de KPack-buildservice
resourceRequests	ResourceRequests	De runtimeresourceconfiguratie van deze buildservice.

BuildServiceProvisioningState

Opsomming

Inrichtingsstatus van de KPack-buildservice

Waarde	Description
Creating
Updating
Succeeded
Failed
Deleting

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Een foutreactie van de service.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

lastModifiedByType

Opsomming

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Waarde	Description
User
Application
ManagedIdentity
Key

ResourceRequests

Object

Nettolading implementatieresourceaanvraag

Name	Type	Description
cpu	string	Vereiste CPU. 1 kern kan worden vertegenwoordigd door 1 of 1000m. Dit moet 500 m of 1 zijn voor de Basic-laag en {500m, 1, 2, 3, 4} voor de Standard-laag.
memory	string	Vereist geheugen. 1 GB kan worden vertegenwoordigd door 1Gi of 1024Mi. Dit moet {512Mi, 1Gi, 2Gi} zijn voor de Basic-laag en {512Mi, 1Gi, 2Gi, ..., 8Gi} voor de Standard-laag.

SystemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van resourcewijziging (UTC).
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Build Service - List Build Services

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

BuildService_ListBuildServices

Voorbeeldaanvraag

Voorbeeldrespons

Definities

BuildService

BuildServiceCollection

BuildServiceProperties

BuildServiceProvisioningState

CloudError

CloudErrorBody

createdByType

lastModifiedByType

ResourceRequests

SystemData