Jobs - Get Detector

Dienst:

Azure Container Apps

API-Version:

2025-01-01

Rufen Sie die Diagnosedaten für einen bestimmten Container-App-Auftrag ab.
Abrufen der Diagnosedaten für einen Container-App-Auftrag.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
detectorName	path	True	string pattern: ^[-\w\._\(\)]+$	Name des Container-App-Auftragsdetektors.
jobName	path	True	string pattern: ^[-\w\._\(\)]+$	Auftragsname
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	Diagnostics	OKAY
Other Status Codes	DefaultErrorResponse	Häufige Fehlerantwort.

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

Get diagnostic data for a Container App Job

Beispielanforderung

HTTP

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

Java

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python job_get_detector.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.jobs.get_detector(
        resource_group_name="mikono-workerapp-test-rg",
        job_name="mikonojob1",
        detector_name="containerappjobnetworkIO",
    )
    print(response)


# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/Job_GetDetector.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 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/Job_GetDetector.json
func ExampleJobsClient_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.NewJobsClient().GetDetector(ctx, "mikono-workerapp-test-rg", "mikonojob1", "containerappjobnetworkIO", 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("containerappjobnetworkIO"),
	// 	Type: to.Ptr("Microsoft.App/jobs/detectors"),
	// 	ID: to.Ptr("/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/containerappjobnetworkIO"),
	// 	Properties: &armappcontainers.DiagnosticsProperties{
	// 		Dataset: []*armappcontainers.DiagnosticsDataAPIResponse{
	// 			{
	// 				RenderingProperties: &armappcontainers.DiagnosticRendering{
	// 					Type: to.Ptr[int32](8),
	// 					Description: to.Ptr(""),
	// 					IsVisible: to.Ptr(true),
	// 					Title: to.Ptr("Container App Job 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("Container App Job Network Inbound and Outbound"),
	// 			Type: to.Ptr("Detector"),
	// 			Description: to.Ptr("This detector shows the Container App Job Network Inbound and Outbound."),
	// 			Author: to.Ptr(""),
	// 			Category: to.Ptr("Availability and Performance"),
	// 			ID: to.Ptr("containerappjobnetworkIO"),
	// 			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

JavaScript

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 Container App Job.
 *
 * @summary Get the diagnostics data for a Container App Job.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2025-01-01/examples/Job_GetDetector.json
 */
async function getDiagnosticDataForAContainerAppJob() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "f07f3711-b45e-40fe-a941-4e6d93f851e6";
  const resourceGroupName =
    process.env["APPCONTAINERS_RESOURCE_GROUP"] || "mikono-workerapp-test-rg";
  const jobName = "mikonojob1";
  const detectorName = "containerappjobnetworkIO";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const result = await client.jobs.getDetector(resourceGroupName, jobName, 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

dotnet

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/Job_GetDetector.json
// this example is just showing the usage of "Jobs_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 ContainerAppJobResource created on azure
// for more information of creating ContainerAppJobResource, please refer to the document of ContainerAppJobResource
string subscriptionId = "f07f3711-b45e-40fe-a941-4e6d93f851e6";
string resourceGroupName = "mikono-workerapp-test-rg";
string jobName = "mikonojob1";
ResourceIdentifier containerAppJobResourceId = ContainerAppJobResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, jobName);
ContainerAppJobResource containerAppJob = client.GetContainerAppJobResource(containerAppJobResourceId);

// get the collection of this ContainerAppJobDetectorResource
ContainerAppJobDetectorCollection collection = containerAppJob.GetContainerAppJobDetectors();

// invoke the operation
string detectorName = "containerappjobnetworkIO";
NullableResponse<ContainerAppJobDetectorResource> response = await collection.GetIfExistsAsync(detectorName);
ContainerAppJobDetectorResource 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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/containerappjobnetworkIO",
  "name": "containerappjobnetworkIO",
  "type": "Microsoft.App/jobs/detectors",
  "properties": {
    "metadata": {
      "id": "containerappjobnetworkIO",
      "name": "Container App Job Network Inbound and Outbound",
      "description": "This detector shows the Container App Job 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": "Container App Job Network Inbound ",
          "description": "",
          "isVisible": true
        }
      }
    ],
    "status": {
      "statusId": 3
    }
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details	Details oder der Fehler
DiagnosticDataProviderMetadata	Liste der Metadaten von Datenanbietern.
DiagnosticDataTableResponseColumn	Spalten in der Tabelle
DiagnosticDataTableResponseObject	Tabellenantwort
DiagnosticRendering	Details der Tabellenantwort
Diagnostics	Diagnosedaten für eine Ressource.
DiagnosticsDataApiResponse	Datensammlungen, die der Antwort zugeordnet sind.
DiagnosticsDefinition	Metadaten der Diagnoseantwort.
DiagnosticsStatus	Status der Diagnoseantwort.
DiagnosticSupportTopic	Liste der Supportthemen
Error	Fehlermodell.
Properties	Diagnoseressourcenspezifische Eigenschaften
PropertyBag	Sammlung von Eigenschaften
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Details oder der Fehler

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

DiagnosticDataProviderMetadata

Objekt

Liste der Metadaten von Datenanbietern.

Name	Typ	Beschreibung
propertyBag	PropertyBag[]	Sammlung von Eigenschaften
providerName	string	Name des Datenanbieters

DiagnosticDataTableResponseColumn

Objekt

Spalten in der Tabelle

Name	Typ	Beschreibung
columnName	string	Spaltenname
columnType	string	Spaltentyp
dataType	string	Datentyp der Spalte

DiagnosticDataTableResponseObject

Objekt

Tabellenantwort

Name	Typ	Beschreibung
columns	DiagnosticDataTableResponseColumn[]	Spalten in der Tabelle
rows	object[]	Zeilen in der Tabelle
tableName	string	Tabellenname

DiagnosticRendering

Objekt

Details der Tabellenantwort

Name	Typ	Beschreibung
description	string	Beschreibung der Tabelle
isVisible	boolean	Kennzeichnen, wenn die Tabelle gerendert werden soll
title	string	Titel der Tabelle
type	integer (int32)	Renderingtyp

Diagnostics

Objekt

Diagnosedaten für eine Ressource.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	Properties	Diagnoseressourcenspezifische Eigenschaften
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DiagnosticsDataApiResponse

Objekt

Datensammlungen, die der Antwort zugeordnet sind.

Name	Typ	Beschreibung
renderingProperties	DiagnosticRendering	Details der Tabellenantwort
table	DiagnosticDataTableResponseObject	Tabellenantwort

DiagnosticsDefinition

Objekt

Metadaten der Diagnoseantwort.

Name	Typ	Beschreibung
analysisTypes	string[]	Liste der Analysetypen
author	string	Autorennamen des Detektors
category	string	Kategorie des Detektors
description	string	Details der Diagnoseinformationen
id	string	Eindeutiger Detektorname
name	string	Anzeigename des Detektors
score	number	Autorennamen des Detektors
supportTopicList	DiagnosticSupportTopic[]	Liste der Supportthemen
type	string	Autorennamen des Detektors

DiagnosticsStatus

Objekt

Status der Diagnoseantwort.

Name	Typ	Beschreibung
message	string	Diagnosenachricht
statusId	integer (int32)	Der Status

DiagnosticSupportTopic

Objekt

Liste der Supportthemen

Name	Typ	Beschreibung
id	string	Eindeutiger Themenbezeichner
pesId	string	PES-ID

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Details oder der Fehler
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Properties

Objekt

Diagnoseressourcenspezifische Eigenschaften

Name	Typ	Beschreibung
dataProviderMetadata	DiagnosticDataProviderMetadata	Liste der Metadaten von Datenanbietern.
dataset	DiagnosticsDataApiResponse[]	Datensammlungen, die der Antwort zugeordnet sind.
metadata	DiagnosticsDefinition	Metadaten der Diagnoseantwort.
status	DiagnosticsStatus	Status der Diagnoseantwort.

PropertyBag

Objekt

Sammlung von Eigenschaften

Name	Typ	Beschreibung
name	string	Eigenschaftsname
value	string	Eigenschaftswert

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 letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.