Buildpack Binding - Get

服务:

Azure Spring Apps

API 版本:

2023-12-01

按名称获取生成包绑定。

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 参数

名称	在	必需	类型	说明
builderName	path	True	string	生成器资源的名称。
buildpackBindingName	path	True	string	Buildpack 绑定名称的名称
buildServiceName	path	True	string	生成服务资源的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	服务资源的名称。
subscriptionId	path	True	string	获取唯一标识 azure 订阅Microsoft的订阅 ID。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	BuildpackBindingResource	成功。 响应描述生成包绑定。
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

BuildpackBinding_Get

示例请求

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

示例响应

状态代码:

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

定义

名称	说明
bindingType	Buildpack 绑定类型
BuildpackBindingLaunchProperties	Buildpack 绑定启动属性
BuildpackBindingProperties	buildpack 绑定的属性
BuildpackBindingProvisioningState	Buildpack 绑定的状态。
BuildpackBindingResource	Buildpack Binding Resource 对象
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
createdByType	创建资源的标识的类型。
lastModifiedByType	上次修改资源的标识的类型。
SystemData	与创建和上次修改资源相关的元数据。

bindingType

枚举

Buildpack 绑定类型

值	说明
ApplicationInsights
ApacheSkyWalking
AppDynamics
Dynatrace
NewRelic
ElasticAPM

BuildpackBindingLaunchProperties

对象

Buildpack 绑定启动属性

名称	类型	说明
properties	object	launchProperties 的非敏感属性
secrets	object	launchProperties 的敏感属性

BuildpackBindingProperties

对象

buildpack 绑定的属性

名称	类型	说明
bindingType	bindingType	Buildpack 绑定类型
launchProperties	BuildpackBindingLaunchProperties	该对象描述 buildpack 绑定启动属性
provisioningState	BuildpackBindingProvisioningState	Buildpack 绑定的状态。

BuildpackBindingProvisioningState

枚举

Buildpack 绑定的状态。

值	说明
Creating
Updating
Succeeded
Failed
Deleting

BuildpackBindingResource

对象

Buildpack Binding Resource 对象

名称	类型	说明
id	string	资源的完全限定资源 ID。
name	string	资源的名称。
properties	BuildpackBindingProperties	buildpack 绑定的属性
systemData	SystemData	与创建和上次修改资源相关的元数据。
type	string	资源的类型。

CloudError

对象

服务的错误响应。

名称	类型	说明
error	CloudErrorBody	服务的错误响应。

CloudErrorBody

对象

服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。 例如，错误属性的名称。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

lastModifiedByType

枚举

上次修改资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

SystemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源修改的时间戳（UTC）。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	lastModifiedByType	上次修改资源的标识的类型。