Web Apps - Start Web Site Network Trace Operation

Description for Start capturing network packets for the site.

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

URI Parameters

Name In Required Type Description
name
path True

string

The name of the web app.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

api-version
query True

string

API Version

durationInSeconds
query

integer

int32

The duration to keep capturing in seconds.

maxFrameLength
query

integer

int32

The maximum frame length in bytes (Optional).

sasUrl
query

string

The Blob URL to store capture file.

Responses

Name Type Description
200 OK

NetworkTrace[]

OK

202 Accepted

NetworkTrace[]

Operation is in progress.

Other Status Codes

DefaultErrorResponse

App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Start a new network trace operation for a site

Sample request

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

Sample response

[
  {
    "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"
  }
]
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
[
  {
    "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"
  }
]

Definitions

Name Description
DefaultErrorResponse

App Service error response.

Details
Error

Error model.

NetworkTrace

Network trace

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

Details

Name Type Description
code

string

Standardized string to programmatically identify the error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

Error

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.

details

Details[]

Detailed errors.

innererror

string

More information to debug error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

NetworkTrace

Network trace

Name Type Description
message

string

Detailed message of a network trace operation, e.g. error message in case of failure.

path

string

Local file path for the captured network trace file.

status

string

Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).