你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Managed Environment Diagnostics - Get Detector

参考

服务:: Azure Container Apps

API 版本:: 2025-01-01

获取给定托管环境的诊断数据。
获取用于托管容器应用的托管环境的诊断数据。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors/{detectorName}?api-version=2025-01-01

URI 参数

名称	在	必需	类型	说明
detectorName	path	True	string	托管环境检测器的名称。
environmentName	path	True	string	环境的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	Diagnostics	好的
Other Status Codes	DefaultErrorResponse	常见的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get diagnostic data for a managed environments

示例请求

GET https://management.azure.com/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics?api-version=2025-01-01


/**
 * Samples for ManagedEnvironmentDiagnostics GetDetector.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/ManagedEnvironmentDiagnostics_Get.
     * json
     */
    /**
     * Sample code: Get diagnostic data for a managed environments.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void getDiagnosticDataForAManagedEnvironments(
        com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.managedEnvironmentDiagnostics().getDetectorWithResponse("mikono-workerapp-test-rg", "mikonokubeenv",
            "ManagedEnvAvailabilityMetrics", 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.appcontainers import ContainerAppsAPIClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python managed_environment_diagnostics_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 = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="f07f3711-b45e-40fe-a941-4e6d93f851e6",
    )

    response = client.managed_environment_diagnostics.get_detector(
        resource_group_name="mikono-workerapp-test-rg",
        environment_name="mikonokubeenv",
        detector_name="ManagedEnvAvailabilityMetrics",
    )
    print(response)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/ManagedEnvironmentDiagnostics_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

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8eb3f7a4f66d408152c32b9d647e59147172d533/specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/ManagedEnvironmentDiagnostics_Get.json
func ExampleManagedEnvironmentDiagnosticsClient_GetDetector() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedEnvironmentDiagnosticsClient().GetDetector(ctx, "mikono-workerapp-test-rg", "mikonokubeenv", "ManagedEnvAvailabilityMetrics", 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.Diagnostics = armappcontainers.Diagnostics{
	// 	Name: to.Ptr("ManagedEnvAvailabilityMetrics"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments/detectors"),
	// 	ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics"),
	// 	Properties: &armappcontainers.DiagnosticsProperties{
	// 		Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
	// 			{
	// 				RenderingProperties: &armappcontainers.DiagnosticRendering{
	// 					Type: to.Ptr[int32](8),
	// 					Description: to.Ptr(""),
	// 					IsVisible: to.Ptr(true),
	// 					Title: to.Ptr("Managed Environment Network Inbound "),
	// 				},
	// 				Table: &armappcontainers.DiagnosticDataTableResponseObject{
	// 					Columns: []*armappcontainers.DiagnosticDataTableResponseColumn{
	// 						{
	// 							ColumnName: to.Ptr("TimeStamp"),
	// 							DataType: to.Ptr("DateTime"),
	// 						},
	// 						{
	// 							ColumnName: to.Ptr("Metric"),
	// 							DataType: to.Ptr("String"),
	// 						},
	// 						{
	// 							ColumnName: to.Ptr("Average"),
	// 							DataType: to.Ptr("Double"),
	// 					}},
	// 					Rows: []any{
	// 						[]any{
	// 							"2022-03-15T21:35:00",
	// 							"RxBytes",
	// 							float64(0),
	// 					}},
	// 					TableName: to.Ptr(""),
	// 				},
	// 		}},
	// 		Metadata: &armappcontainers.DiagnosticsDefinition{
	// 			Name: to.Ptr("Managed Env Netowrk Inbound and Outbound"),
	// 			Type: to.Ptr("Detector"),
	// 			Description: to.Ptr("This detector shows the Managed Environment Network Inbound and Outbound."),
	// 			Author: to.Ptr(""),
	// 			Category: to.Ptr("Availability and Performance"),
	// 			ID: to.Ptr("ManagedEnvAvailabilityMetrics"),
	// 			Score: to.Ptr[float32](0),
	// 			SupportTopicList: []*armappcontainers.DiagnosticSupportTopic{
	// 			},
	// 		},
	// 		Status: &armappcontainers.DiagnosticsStatus{
	// 			StatusID: to.Ptr[int32](3),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get the diagnostics data for a Managed Environment used to host container apps.
 *
 * @summary Get the diagnostics data for a Managed Environment used to host container apps.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/ManagedEnvironmentDiagnostics_Get.json
 */
async function getDiagnosticDataForAManagedEnvironments() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "f07f3711-b45e-40fe-a941-4e6d93f851e6";
  const resourceGroupName =
    process.env["APPCONTAINERS_RESOURCE_GROUP"] || "mikono-workerapp-test-rg";
  const environmentName = "mikonokubeenv";
  const detectorName = "ManagedEnvAvailabilityMetrics";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const result = await client.managedEnvironmentDiagnostics.getDetector(
    resourceGroupName,
    environmentName,
    detectorName,
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/ManagedEnvironmentDiagnostics_Get.json
// this example is just showing the usage of "ManagedEnvironmentDiagnostics_GetDetector" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerAppManagedEnvironmentResource created on azure
// for more information of creating ContainerAppManagedEnvironmentResource, please refer to the document of ContainerAppManagedEnvironmentResource
string subscriptionId = "f07f3711-b45e-40fe-a941-4e6d93f851e6";
string resourceGroupName = "mikono-workerapp-test-rg";
string environmentName = "mikonokubeenv";
ResourceIdentifier containerAppManagedEnvironmentResourceId = ContainerAppManagedEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, environmentName);
ContainerAppManagedEnvironmentResource containerAppManagedEnvironment = client.GetContainerAppManagedEnvironmentResource(containerAppManagedEnvironmentResourceId);

// get the collection of this ContainerAppManagedEnvironmentDetectorResource
ContainerAppManagedEnvironmentDetectorCollection collection = containerAppManagedEnvironment.GetContainerAppManagedEnvironmentDetectors();

// invoke the operation
string detectorName = "ManagedEnvAvailabilityMetrics";
NullableResponse<ContainerAppManagedEnvironmentDetectorResource> response = await collection.GetIfExistsAsync(detectorName);
ContainerAppManagedEnvironmentDetectorResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ContainerAppDiagnosticData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics",
  "name": "ManagedEnvAvailabilityMetrics",
  "type": "Microsoft.App/managedEnvironments/detectors",
  "properties": {
    "metadata": {
      "id": "ManagedEnvAvailabilityMetrics",
      "name": "Managed Env Netowrk Inbound and Outbound",
      "description": "This detector shows the Managed Environment Network Inbound and Outbound.",
      "author": "",
      "category": "Availability and Performance",
      "supportTopicList": [],
      "type": "Detector",
      "score": 0
    },
    "dataset": [
      {
        "table": {
          "tableName": "",
          "columns": [
            {
              "columnName": "TimeStamp",
              "dataType": "DateTime"
            },
            {
              "columnName": "Metric",
              "dataType": "String"
            },
            {
              "columnName": "Average",
              "dataType": "Double"
            }
          ],
          "rows": [
            [
              "2022-03-15T21:35:00",
              "RxBytes",
              0
            ]
          ]
        },
        "renderingProperties": {
          "type": 8,
          "title": "Managed Environment Network Inbound ",
          "description": "",
          "isVisible": true
        }
      }
    ],
    "status": {
      "statusId": 3
    }
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
DefaultErrorResponse	应用服务错误响应。
Details	详细信息或错误
DiagnosticDataProviderMetadata	诊断数据提供程序的详细信息
DiagnosticDataTableResponseColumn	诊断数据列
DiagnosticDataTableResponseObject	诊断数据表
DiagnosticRendering	呈现诊断表的详细信息
Diagnostics	诊断资源的数据。
DiagnosticsDataApiResponse	从检测器返回的诊断数据
DiagnosticsDefinition	诊断响应的元数据
DiagnosticsStatus	呈现诊断表的详细信息
DiagnosticSupportTopic	支持主题信息
Error	错误模型。
Properties	诊断资源特定属性
PropertyBag	属性集合
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DefaultErrorResponse

Object

应用服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

Object

详细信息或错误

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

DiagnosticDataProviderMetadata

Object

诊断数据提供程序的详细信息

名称	类型	说明
propertyBag	PropertyBag[]	属性集合
providerName	string	数据提供程序的名称

DiagnosticDataTableResponseColumn

Object

诊断数据列

名称	类型	说明
columnName	string	列名称
columnType	string	列类型
dataType	string	列的数据类型

DiagnosticDataTableResponseObject

Object

诊断数据表

名称	类型	说明
columns	DiagnosticDataTableResponseColumn[]	表中的列
rows	object[]	表中的行
tableName	string	表名称

DiagnosticRendering

Object

呈现诊断表的详细信息

名称	类型	说明
description	string	表的说明
isVisible	boolean	如果应呈现表，则标记
title	string	表的标题
type	integer (int32)	呈现类型

Diagnostics

Object

诊断资源的数据。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	Properties	诊断资源特定属性
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DiagnosticsDataApiResponse

Object

从检测器返回的诊断数据

名称	类型	说明
renderingProperties	DiagnosticRendering	表响应的详细信息
table	DiagnosticDataTableResponseObject	表响应

DiagnosticsDefinition

Object

诊断响应的元数据

名称	类型	说明
analysisTypes	string[]	分析类型列表
author	string	作者的姓名检测器
category	string	检测器的类别
description	string	诊断信息的详细信息
id	string	唯一检测器名称
name	string	检测器的显示名称
score	number	作者的姓名检测器
supportTopicList	DiagnosticSupportTopic[]	支持主题列表
type	string	作者的姓名检测器

DiagnosticsStatus

Object

呈现诊断表的详细信息

名称	类型	说明
message	string	诊断消息
statusId	integer (int32)	状态

DiagnosticSupportTopic

Object

支持主题信息

名称	类型	说明
id	string	唯一主题标识符
pesId	string	PES 标识符

Error

Object

错误模型。

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
details	Details[]	详细信息或错误
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Properties

Object

诊断资源特定属性

名称	类型	说明
dataProviderMetadata	DiagnosticDataProviderMetadata	数据提供程序的元数据列表。
dataset	DiagnosticsDataApiResponse[]	与响应关联的数据集。
metadata	DiagnosticsDefinition	诊断响应的元数据。
status	DiagnosticsStatus	诊断响应的状态。

PropertyBag

Object

属性集合

名称	类型	说明
name	string	属性名称
value	string	属性值

systemData

Object

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

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