Buildpack Binding - Get

Dienst:

Azure Spring Apps

API-Version:

2023-12-01

Rufen Sie eine Buildpack-Bindung anhand des Namens ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
builderName	path	True	string	Der Name der Generatorressource.
buildpackBindingName	path	True	string	Der Name des Buildpack-Bindungsnamens
buildServiceName	path	True	string	Der Name der Builddienstressource.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Der Name der Dienstressource.
subscriptionId	path	True	string	Ruft die Abonnement-ID ab, die das Microsoft Azure-Abonnement eindeutig identifiziert. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	BuildpackBindingResource	Erfolg. Die Antwort beschreibt eine Buildpack-Bindung.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

BuildpackBinding_Get

Beispielanforderung

HTTP

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

Java

/**
 * Samples for BuildpackBinding Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_Get.
     * json
     */
    /**
     * Sample code: BuildpackBinding_Get.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void buildpackBindingGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getBuildpackBindings().getWithResponse("myResourceGroup",
            "myservice", "default", "default", "myBuildpackBinding", 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 buildpack_binding_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.buildpack_binding.get(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        build_service_name="default",
        builder_name="default",
        buildpack_binding_name="myBuildpackBinding",
    )
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_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/BuildpackBinding_Get.json
func ExampleBuildpackBindingClient_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.NewBuildpackBindingClient().Get(ctx, "myResourceGroup", "myservice", "default", "default", "myBuildpackBinding", 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.BuildpackBindingResource = armappplatform.BuildpackBindingResource{
	// 	Name: to.Ptr("myBuildpackBinding"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/buildServices/builders/buildpackBindings"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding"),
	// 	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.BuildpackBindingProperties{
	// 		BindingType: to.Ptr(armappplatform.BindingTypeApplicationInsights),
	// 		LaunchProperties: &armappplatform.BuildpackBindingLaunchProperties{
	// 			Properties: map[string]*string{
	// 				"abc": to.Ptr("def"),
	// 				"any-string": to.Ptr("any-string"),
	// 				"sampling-rate": to.Ptr("12.0"),
	// 			},
	// 			Secrets: map[string]*string{
	// 				"connection-string": to.Ptr("*"),
	// 			},
	// 		},
	// 	},
	// }
}

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 buildpack binding by name.
 *
 * @summary Get a buildpack binding by name.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/BuildpackBinding_Get.json
 */
async function buildpackBindingGet() {
  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 = "default";
  const buildpackBindingName = "myBuildpackBinding";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.buildpackBinding.get(
    resourceGroupName,
    serviceName,
    buildServiceName,
    builderName,
    buildpackBindingName,
  );
  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

Beispiel für eine Antwort

Statuscode:

200

{
  "properties": {
    "bindingType": "ApplicationInsights",
    "launchProperties": {
      "properties": {
        "abc": "def",
        "any-string": "any-string",
        "sampling-rate": "12.0"
      },
      "secrets": {
        "connection-string": "*"
      }
    }
  },
  "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/buildpackBindings",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/buildServices/default/builders/default/buildpackBindings/myBuildpackBinding",
  "name": "myBuildpackBinding"
}

Definitionen

Name	Beschreibung
bindingType	Buildpack-Bindungstyp
BuildpackBindingLaunchProperties	Eigenschaften für den Start der Buildpack-Bindung
BuildpackBindingProperties	Eigenschaften einer Buildpack-Bindung
BuildpackBindingProvisioningState	Status der Buildpack-Bindung.
BuildpackBindingResource	Buildpack Binding Resource-Objekt
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

bindingType

Enumeration

Buildpack-Bindungstyp

Wert	Beschreibung
ApplicationInsights
ApacheSkyWalking
AppDynamics
Dynatrace
NewRelic
ElasticAPM

BuildpackBindingLaunchProperties

Objekt

Eigenschaften für den Start der Buildpack-Bindung

Name	Typ	Beschreibung
properties	object	Nicht vertrauliche Eigenschaften für launchProperties
secrets	object	Vertrauliche Eigenschaften für launchProperties

BuildpackBindingProperties

Objekt

Eigenschaften einer Buildpack-Bindung

Name	Typ	Beschreibung
bindingType	bindingType	Buildpack-Bindungstyp
launchProperties	BuildpackBindingLaunchProperties	Das Objekt beschreibt die Buildpack-Bindungsstarteigenschaften.
provisioningState	BuildpackBindingProvisioningState	Status der Buildpack-Bindung.

BuildpackBindingProvisioningState

Enumeration

Status der Buildpack-Bindung.

Wert	Beschreibung
Creating
Updating
Succeeded
Failed
Deleting

BuildpackBindingResource

Objekt

Buildpack Binding Resource-Objekt

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource.
name	string	Der Name der Ressource.
properties	BuildpackBindingProperties	Eigenschaften einer Buildpack-Bindung
systemData	SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Typ der Ressource.

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort des Diensts.

CloudErrorBody

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

lastModifiedByType

Enumeration

Der Identitätstyp, der die Ressource zuletzt geändert hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der Ressourcenänderung (UTC).
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	lastModifiedByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.