Application Live Views - Get

服务:

Azure Spring Apps

API 版本:

2023-12-01

获取应用程序实时及其属性。

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

URI 参数

名称	在	必需	类型	说明
applicationLiveViewName	path	True	string pattern: ^[a-z][a-z0-9]*$	应用程序实时视图的名称。
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	ApplicationLiveViewResource	成功。 响应描述相应的应用程序实时视图。
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApplicationLiveViews_Get

示例请求

HTTP

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

Java

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


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationLiveViews_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/ApplicationLiveViews_Get.json
func ExampleApplicationLiveViewsClient_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.NewApplicationLiveViewsClient().Get(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.ApplicationLiveViewResource = armappplatform.ApplicationLiveViewResource{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/applicationLiveViews"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/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.ApplicationLiveViewProperties{
	// 		Components: []*armappplatform.ApplicationLiveViewComponent{
	// 			{
	// 				Name: "app-live-view-server",
	// 				Instances: []*armappplatform.ApplicationLiveViewInstance{
	// 					{
	// 						Name: to.Ptr("app-live-view-server-name"),
	// 						Status: to.Ptr("Running"),
	// 				}},
	// 				ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
	// 					CPU: to.Ptr("1"),
	// 					InstanceCount: to.Ptr[int32](1),
	// 					Memory: to.Ptr("1Gi"),
	// 				},
	// 			},
	// 			{
	// 				Name: "app-live-view-connector",
	// 				Instances: []*armappplatform.ApplicationLiveViewInstance{
	// 					{
	// 						Name: to.Ptr("app-live-view-connector-name1"),
	// 						Status: to.Ptr("Starting"),
	// 				}},
	// 				ResourceRequests: &armappplatform.ApplicationLiveViewResourceRequests{
	// 					CPU: to.Ptr("500m"),
	// 					InstanceCount: to.Ptr[int32](1),
	// 					Memory: to.Ptr("500Mi"),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armappplatform.ApplicationLiveViewProvisioningStateSucceeded),
	// 	},
	// }
}

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 the Application Live  and its properties.
 *
 * @summary Get the Application Live  and its properties.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/ApplicationLiveViews_Get.json
 */
async function applicationLiveViewsGet() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const applicationLiveViewName = "default";
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.applicationLiveViews.get(
    resourceGroupName,
    serviceName,
    applicationLiveViewName,
  );
  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": {
    "provisioningState": "Succeeded",
    "components": [
      {
        "name": "app-live-view-server",
        "resourceRequests": {
          "cpu": "1",
          "memory": "1Gi",
          "instanceCount": 1
        },
        "instances": [
          {
            "name": "app-live-view-server-name",
            "status": "Running"
          }
        ]
      },
      {
        "name": "app-live-view-connector",
        "resourceRequests": {
          "cpu": "500m",
          "memory": "500Mi",
          "instanceCount": 1
        },
        "instances": [
          {
            "name": "app-live-view-connector-name1",
            "status": "Starting"
          }
        ]
      }
    ]
  },
  "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/applicationLiveViews",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/applicationLiveViews/default",
  "name": "default"
}

定义

名称	说明
ApplicationLiveViewComponent	应用程序实时视图属性有效负载
ApplicationLiveViewInstance	实例集合属于应用程序实时视图
ApplicationLiveViewProperties	应用程序实时视图属性有效负载
ApplicationLiveViewProvisioningState	应用程序实时视图的状态。
ApplicationLiveViewResource	应用程序实时视图资源
ApplicationLiveViewResourceRequests	应用程序实时视图组件所需的 CPU 和内存的资源数量
CloudError	服务的错误响应。
CloudErrorBody	服务的错误响应。
createdByType	创建资源的标识的类型。
lastModifiedByType	上次修改资源的标识的类型。
SystemData	与创建和上次修改资源相关的元数据。

ApplicationLiveViewComponent

对象

应用程序实时视图属性有效负载

名称	类型	说明
instances	ApplicationLiveViewInstance[]	实例集合属于应用程序实时视图。
name		组件的名称。
resourceRequests	ApplicationLiveViewResourceRequests	所需的 CPU 和内存的请求资源数量。

ApplicationLiveViewInstance

对象

实例集合属于应用程序实时视图

名称	类型	说明
name	string	应用程序实时视图实例的名称。
status	string	应用程序实时视图实例的状态。 它可以是挂起、正在运行、成功、失败、未知。

ApplicationLiveViewProperties

对象

应用程序实时视图属性有效负载

名称	类型	说明
components	ApplicationLiveViewComponent[]	应用程序实时视图的组件详细信息
provisioningState	ApplicationLiveViewProvisioningState	应用程序实时视图的状态。

ApplicationLiveViewProvisioningState

枚举

应用程序实时视图的状态。

值	说明
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ApplicationLiveViewResource

对象

应用程序实时视图资源

名称	类型	说明
id	string	资源的完全限定资源 ID。
name	string	资源的名称。
properties	ApplicationLiveViewProperties	应用程序实时视图属性有效负载
systemData	SystemData	与创建和上次修改资源相关的元数据。
type	string	资源的类型。

ApplicationLiveViewResourceRequests

对象

应用程序实时视图组件所需的 CPU 和内存的资源数量

名称	类型	说明
cpu	string	分配给每个应用程序实时视图组件实例的 Cpu 数量。 1 核可以表示 1 或 1000 米。
instanceCount	integer (int32)	应用程序实时视图组件实例的所需实例计数。
memory	string	分配给每个应用程序实时视图组件实例的内存数量。 1 GB 可以由 1Gi 或 1024Mi 表示。

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	上次修改资源的标识的类型。