Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}?api-version=2024-04-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
name
|
path |
True
|
string
|
Name of the app.
|
|
operationId
|
path |
True
|
string
|
GUID of the operation.
|
|
resourceGroupName
|
path |
True
|
string
|
Name of the resource group to which the resource belongs.
Regex pattern: ^[-\w\._\(\)]+[^\.]$
|
|
slot
|
path |
True
|
string
|
Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.
|
|
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
|
Responses
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
Get NetworkTraces for a site
Sample request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/slots/Production/networkTrace/c291433b-53ad-4c49-8cae-0a293eae1c6d?api-version=2024-04-01
/**
* Samples for WebApps GetNetworkTraces.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraces.json
*/
/**
* Sample code: Get NetworkTraces for a site.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getNetworkTracesForASite(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getWebApps().getNetworkTracesWithResponse("testrg123", "SampleApp",
"c291433b-53ad-4c49-8cae-0a293eae1c6d", 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
package armappservice_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraces.json
func ExampleWebAppsClient_GetNetworkTraces() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWebAppsClient().GetNetworkTraces(ctx, "testrg123", "SampleApp", "c291433b-53ad-4c49-8cae-0a293eae1c6d", 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.NetworkTraceArray = []*armappservice.NetworkTrace{
// {
// Path: to.Ptr("D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip"),
// Message: to.Ptr("Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip"),
// Status: to.Ptr("Succeeded"),
// }}
}
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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;
// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWebSiteNetworkTraces.json
// this example is just showing the usage of "WebApps_GetNetworkTracesV2" 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 WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "SampleApp";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);
// invoke the operation and iterate over the result
string operationId = "c291433b-53ad-4c49-8cae-0a293eae1c6d";
await foreach (WebAppNetworkTrace item in webSite.GetNetworkTracesV2Async(operationId))
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine("Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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"
}
]
Definitions
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).
|