Web Apps - Start Web Site Network Trace Operation

Referenz

Service:: App Service

API Version:: 2023-12-01

Beschreibung für Starten der Erfassung von Netzwerkpaketen für den Standort.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation?api-version=2023-12-01

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation?durationInSeconds={durationInSeconds}&maxFrameLength={maxFrameLength}&sasUrl={sasUrl}&api-version=2023-12-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Der Name der Web-App.
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-00000000000000000).
api-version	query	True	string	API-Version
durationInSeconds	query		integer int32	Die Dauer der Aufzeichnung in Sekunden.
maxFrameLength	query		integer int32	Die maximale Framelänge in Bytes (optional).
sasUrl	query		string	Die Blob-URL zum Speichern der Erfassungsdatei.

Antworten

Name	Typ	Beschreibung
200 OK	NetworkTrace[]	OK
202 Accepted	NetworkTrace[]	Der Vorgang wird ausgeführt.
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Start a new network trace operation for a site

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networkTrace/startOperation?durationInSeconds=60&api-version=2023-12-01

Sample Response

Status code:: 200

[
  {
    "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
    "status": "Succeeded",
    "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip"
  }
]

Status code:: 202

location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d
azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d

Response Body

[
  {
    "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip",
    "status": "Succeeded",
    "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip"
  }
]

Definitionen

Name	Beschreibung
DefaultErrorResponse	App Service Fehlerantwort.
Details
Error	Fehlermodell.
NetworkTrace	Netzwerkablaufverfolgung

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen des Fehlers.
message	string	Ausführliche Fehlerbeschreibung und Debuginformationen.
target	string	Ausführliche Fehlerbeschreibung und Debuginformationen.

NetworkTrace

Netzwerkablaufverfolgung

Name	Typ	Beschreibung
message	string	Ausführliche Meldung eines Netzwerkablaufverfolgungsvorgangs, z. B. Fehlermeldung im Fehlerfall.
path	string	Lokaler Dateipfad für die erfasste Netzwerkablaufverfolgungsdatei.
status	string	Aktuelle status des Netzwerkablaufverfolgungsvorgangs, identisch mit Operation.Status (InProgress/Succeeded/Failed).

Share via