Network Watchers - Get Troubleshooting

서비스:: Network Watcher

API 버전:: 2025-05-01

지정된 리소스에서 문제 해결을 시작합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot?api-version=2025-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
networkWatcherName	path	True	string	네트워크 감시자의 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
properties.storageId	True	string	문제 해결 결과를 저장할 스토리지 계정의 ID입니다.
properties.storagePath	True	string	문제 해결 결과를 저장할 Blob의 경로입니다.
targetResourceId	True	string	문제를 해결할 대상 리소스입니다.

응답

Name	형식	Description
200 OK	TroubleshootingResult	Azure 작업이 성공적으로 완료되었습니다.
202 Accepted	TroubleshootingResult	처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다. 헤더 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

Name

형식

Description

200 OK

TroubleshootingResult

Azure 작업이 성공적으로 완료되었습니다.

202 Accepted

TroubleshootingResult

처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

헤더

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get troubleshooting

샘플 요청

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/troubleshoot?api-version=2025-05-01

{
  "properties": {
    "storageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    "storagePath": "https://st1.blob.core.windows.net/cn1"
  },
  "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python network_watcher_troubleshoot_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.network_watchers.begin_get_troubleshooting(
        resource_group_name="rg1",
        network_watcher_name="nw1",
        parameters={
            "properties": {
                "storageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
                "storagePath": "https://st1.blob.core.windows.net/cn1",
            },
            "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-05-01/NetworkWatcherTroubleshootGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Initiate troubleshooting on a specified resource.
 *
 * @summary Initiate troubleshooting on a specified resource.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/NetworkWatcherTroubleshootGet.json
 */
async function getTroubleshooting() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkWatcherName = "nw1";
  const parameters = {
    storageId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1",
    storagePath: "https://st1.blob.core.windows.net/cn1",
    targetResourceId:
      "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.networkWatchers.beginGetTroubleshootingAndWait(
    resourceGroupName,
    networkWatcherName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:: 200

{
  "code": "UnHealthy",
  "endTime": "2017-01-12T00:20:09.914Z",
  "results": [
    {
      "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected",
      "id": "000000",
      "reasonType": "VipUnResponsive",
      "recommendedActions": [
        {
          "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet",
          "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal",
          "actionUriText": "Verify"
        },
        {
          "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support",
          "actionUri": "http://azure.microsoft.com/support",
          "actionUriText": "contact support"
        }
      ],
      "summary": "We are sorry, your VPN gateway is unreachable from the Internet"
    }
  ],
  "startTime": "2017-01-12T00:19:47.0442834Z"
}

상태 코드:: 202

Location: https:/management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/troubleshoot?api-version=2025-05-01

{
  "code": "UnHealthy",
  "endTime": "2017-01-12T00:20:09.914Z",
  "results": [
    {
      "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected",
      "id": "000000",
      "reasonType": "VipUnResponsive",
      "recommendedActions": [
        {
          "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet",
          "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal",
          "actionUriText": "Verify"
        },
        {
          "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support",
          "actionUri": "http://azure.microsoft.com/support",
          "actionUriText": "contact support"
        }
      ],
      "summary": "We are sorry, your VPN gateway is unreachable from the Internet"
    }
  ],
  "startTime": "2017-01-12T00:19:47.0442834Z"
}

정의

Name	Description
ErrorDetails	일반적인 오류 세부 정보 표현입니다.
ErrorResponse	오류 개체입니다.
TroubleshootingDetails	지정된 리소스의 문제 해결을 통해 얻은 정보입니다.
TroubleshootingParameters	문제를 해결할 리소스를 정의하는 매개 변수입니다.
TroubleshootingRecommendedActions	검색된 문제에 따라 권장되는 작업입니다.
TroubleshootingResult	지정된 리소스에서 얻은 문제 해결 정보입니다.

ErrorDetails

Object

일반적인 오류 세부 정보 표현입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 개체입니다.

Name	형식	Description
error	ErrorDetails	오류 오류 세부 정보 개체입니다.

TroubleshootingDetails

Object

지정된 리소스의 문제 해결을 통해 얻은 정보입니다.

Name	형식	Description
detail	string	문제 해결 결과에 대한 세부 정보입니다.
id	string	get 문제 해결 작업의 ID입니다.
reasonType	string	실패 이유 유형입니다.
recommendedActions	TroubleshootingRecommendedActions[]	권장 작업 목록입니다.
summary	string	문제 해결 요약입니다.

TroubleshootingParameters

Object

문제를 해결할 리소스를 정의하는 매개 변수입니다.

Name	형식	Description
properties.storageId	string	문제 해결 결과를 저장할 스토리지 계정의 ID입니다.
properties.storagePath	string	문제 해결 결과를 저장할 Blob의 경로입니다.
targetResourceId	string	문제를 해결할 대상 리소스입니다.

TroubleshootingRecommendedActions

Object

검색된 문제에 따라 권장되는 작업입니다.

Name	형식	Description
actionId	string	권장 작업의 ID입니다.
actionText	string	권장 조치에 대한 설명입니다.
actionUri	string	권장되는 문제 해결 작업에 대한 설명서에 연결되는 uri입니다.
actionUriText	string	권장 문제 해결 작업에 대한 URI의 정보입니다.

TroubleshootingResult

Object

지정된 리소스에서 얻은 문제 해결 정보입니다.

Name	형식	Description
code	string	문제 해결의 결과 코드입니다.
endTime	string (date-time)	문제 해결의 종료 시간입니다.
results	TroubleshootingDetails[]	문제 해결의 정보입니다.
startTime	string (date-time)	문제 해결의 시작 시간입니다.