Web Apps - Start Network Trace

リファレンス

Service:: App Service

API Version:: 2023-12-01

「サイトのネットワークパケットのキャプチャを開始する」の説明。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	Web アプリの名前。
resourceGroupName	path	True	string	リソースが属しているリソースグループの名前。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure のサブスクリプション ID。これは GUID 形式の文字列です (たとえば、000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000、
api-version	query	True	string	API バージョン
durationInSeconds	query		integer int32	キャプチャを続ける時間 (秒単位)。
maxFrameLength	query		integer int32	フレームの最大長 (バイト単位) (省略可能)。
sasUrl	query		string	キャプチャファイルを格納する BLOB URL。

応答

名前	型	説明
200 OK	NetworkTrace[]	OK
202 Accepted	NetworkTrace[]	操作が進行中です。
Other Status Codes	DefaultErrorResponse	エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

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/startNetworkTrace?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"
  }
]

定義

名前	説明
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
Error	エラーモデル。
NetworkTrace	ネットワークトレース

DefaultErrorResponse

エラー応答をApp Serviceします。

名前	型	説明
error	Error	エラーモデル。

Details

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	詳細なエラーの説明とデバッグ情報。
target	string	詳細なエラーの説明とデバッグ情報。

Error

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	エラーのデバッグに関する詳細情報。
message	string	詳細なエラーの説明とデバッグ情報。
target	string	詳細なエラーの説明とデバッグ情報。

NetworkTrace

ネットワークトレース

名前	型	説明
message	string	ネットワークトレース操作の詳細なメッセージ (エラーが発生した場合のエラーメッセージなど)。
path	string	キャプチャされたネットワークトレースファイルのローカルファイルパス。
status	string	ネットワークトレース操作の現在の状態。Operation.Status (InProgress/Succeeded/Failed) と同じです。