Get URL and Status for Gateway Diagnostics Capture

  • Article

 

The Get URL and Status for Gateway Diagnostics Capture operation returns the status of a diagnostics capture and returns the URL that points to the diagnostics capture data in the storage account that is associated with the specified subscription.

Request

The Get URL and Status for Gateway Diagnostics Capture request may be specified as follows. Replace <subscription-id> with the subscription ID and <virtual-network-name> with the name of the virtual network associated with the virtual network gateway.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/networking/<virtual-network-name>/gateway/publicdiagnostics

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. The value for this header should be set to 2012-03-01 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a response body, and a set of response headers.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

The format of the response body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<GatewayPublicDiagnosticsStatus>
  <State>status-of-diagnostics-capture</State>
  <PublicDiagnosticsUrl>URL-to-diagnostics-capture-data</Subject>
</GatewayPublicDiagnosticsStatus>

The following table describes the elements in the response body.

Response Element

Description

State

Specifies the status of the current diagnostics capture.

Possible values are:

  • Ready

  • Scheduled

  • InProgress

  • StopInProgress

PublicDiagnosticsUrl

Specifies the URL that points to the latest diagnostics capture data in a storage account.