Rufen Sie das letzte abgeschlossene Problembehandlungsergebnis für eine angegebene Ressource ab.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult?api-version=2023-09-01
URI-Parameter
| Name |
In |
Erforderlich |
Typ |
Beschreibung |
|
networkWatcherName
|
path |
True
|
string
|
Der Name der Netzwerküberwachungsressource.
|
|
resourceGroupName
|
path |
True
|
string
|
Der Name der Ressourcengruppe.
|
|
subscriptionId
|
path |
True
|
string
|
Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
|
|
api-version
|
query |
True
|
string
|
Client-API-Version.
|
Anforderungstext
| Name |
Erforderlich |
Typ |
Beschreibung |
|
targetResourceId
|
True
|
string
|
Die Zielressourcen-ID zum Abfragen des Problembehandlungsergebnisses.
|
Antworten
| Name |
Typ |
Beschreibung |
|
200 OK
|
TroubleshootingResult
|
Die Ergebnisanforderung zur Problembehandlung wurde erfolgreich abgerufen.
|
|
202 Accepted
|
TroubleshootingResult
|
Akzeptierte Ergebnisanforderung zur Problembehandlung.
|
|
Other Status Codes
|
ErrorResponse
|
Fehlerantwort mit Beschreibung des Grunds für den Fehler.
|
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Beschreibung |
|
user_impersonation
|
Identitätswechsel Ihres Benutzerkontos
|
Beispiele
Get troubleshoot result
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryTroubleshootResult?api-version=2023-09-01
{
"targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"
}
import com.azure.resourcemanager.network.models.QueryTroubleshootingParameters;
/**
* Samples for NetworkWatchers GetTroubleshootingResult.
*/
public final class Main {
/*
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
* NetworkWatcherTroubleshootResultQuery.json
*/
/**
* Sample code: Get troubleshoot result.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getTroubleshootResult(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getNetworkWatchers().getTroubleshootingResult("rg1", "nw1",
new QueryTroubleshootingParameters().withTargetResourceId(
"/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
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
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_result_query.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="subid",
)
response = client.network_watchers.begin_get_troubleshooting_result(
resource_group_name="rg1",
network_watcher_name="nw1",
parameters={
"targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"
},
).result()
print(response)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherTroubleshootResultQuery.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
package armnetwork_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherTroubleshootResultQuery.json
func ExampleWatchersClient_BeginGetTroubleshootingResult() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewWatchersClient().BeginGetTroubleshootingResult(ctx, "rg1", "nw1", armnetwork.QueryTroubleshootingParameters{
TargetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %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.TroubleshootingResult = armnetwork.TroubleshootingResult{
// Code: to.Ptr("UnHealthy"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-12T00:20:09.914Z"); return t}()),
// Results: []*armnetwork.TroubleshootingDetails{
// {
// Detail: to.Ptr("During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected"),
// ID: to.Ptr("000000"),
// ReasonType: to.Ptr("VipUnResponsive"),
// RecommendedActions: []*armnetwork.TroubleshootingRecommendedActions{
// {
// ActionText: to.Ptr("Verify if there is a network security group (NSG) applied to the GatewaySubnet"),
// ActionURI: to.Ptr("https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal"),
// ActionURIText: to.Ptr("Verify"),
// },
// {
// ActionText: to.Ptr("If your VPN gateway isn't up and running by the expected resolution time, contact support"),
// ActionURI: to.Ptr("http://azure.microsoft.com/support"),
// ActionURIText: to.Ptr("contact support"),
// }},
// Summary: to.Ptr("We are sorry, your VPN gateway is unreachable from the Internet"),
// }},
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-01-12T00:19:47.044Z"); return t}()),
// }
}
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");
/**
* This sample demonstrates how to Get the last completed troubleshooting result on a specified resource.
*
* @summary Get the last completed troubleshooting result on a specified resource.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherTroubleshootResultQuery.json
*/
async function getTroubleshootResult() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const networkWatcherName = "nw1";
const parameters = {
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.beginGetTroubleshootingResultAndWait(
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
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/NetworkWatcherTroubleshootResultQuery.json
// this example is just showing the usage of "NetworkWatchers_GetTroubleshootingResult" 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 NetworkWatcherResource created on azure
// for more information of creating NetworkWatcherResource, please refer to the document of NetworkWatcherResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string networkWatcherName = "nw1";
ResourceIdentifier networkWatcherResourceId = NetworkWatcherResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkWatcherName);
NetworkWatcherResource networkWatcher = client.GetNetworkWatcherResource(networkWatcherResourceId);
// invoke the operation
QueryTroubleshootingContent content = new QueryTroubleshootingContent(new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1"));
ArmOperation<TroubleshootingResult> lro = await networkWatcher.GetTroubleshootingResultAsync(WaitUntil.Completed, content);
TroubleshootingResult result = lro.Value;
Console.WriteLine($"Succeeded: {result}");
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
{
"startTime": "2017-01-12T00:19:47.0442834Z",
"endTime": "2017-01-12T00:20:09.914Z",
"code": "UnHealthy",
"results": [
{
"id": "000000",
"reasonType": "VipUnResponsive",
"summary": "We are sorry, your VPN gateway is unreachable from the Internet",
"detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected",
"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"
}
]
}
]
}
Location: https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryTroubleshootResult?api-version=2023-09-01
{
"startTime": "2017-01-12T00:19:47.0442834Z",
"endTime": "2017-01-12T00:20:09.914Z",
"code": "UnHealthy",
"results": [
{
"id": "000000",
"reasonType": "VipUnResponsive",
"summary": "We are sorry, your VPN gateway is unreachable from the Internet",
"detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected",
"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"
}
]
}
]
}
Definitionen
ErrorDetails
Allgemeine Darstellung von Fehlerdetails.
| Name |
Typ |
Beschreibung |
|
code
|
string
|
Fehlercode
|
|
message
|
string
|
Fehlermeldung.
|
|
target
|
string
|
Fehlerziel.
|
ErrorResponse
Das Fehlerobjekt.
| Name |
Typ |
Beschreibung |
|
error
|
ErrorDetails
|
Fehler
Das Fehlerdetailsobjekt.
|
QueryTroubleshootingParameters
Parameter, die die Ressource definieren, um das Problembehandlungsergebnis abzufragen.
| Name |
Typ |
Beschreibung |
|
targetResourceId
|
string
|
Die Zielressourcen-ID zum Abfragen des Problembehandlungsergebnisses.
|
TroubleshootingDetails
Informationen, die aus der Problembehandlung für die angegebene Ressource gewonnen werden.
| Name |
Typ |
Beschreibung |
|
detail
|
string
|
Details zu Den Ergebnissen der Problembehandlung.
|
|
id
|
string
|
Die ID des Vorgangs "Problembehandlung abrufen".
|
|
reasonType
|
string
|
Fehlertyp des Grunds.
|
|
recommendedActions
|
TroubleshootingRecommendedActions[]
|
Liste der empfohlenen Aktionen.
|
|
summary
|
string
|
Eine Zusammenfassung der Problembehandlung.
|
TroubleshootingRecommendedActions
Empfohlene Aktionen basierend auf ermittelten Problemen.
| Name |
Typ |
Beschreibung |
|
actionId
|
string
|
ID der empfohlenen Aktion.
|
|
actionText
|
string
|
Beschreibung der empfohlenen Aktionen.
|
|
actionUri
|
string
|
Der URI, der mit einer Dokumentation für die empfohlenen Problembehandlungsaktionen verknüpft ist.
|
|
actionUriText
|
string
|
Die Informationen aus dem URI für die empfohlenen Problembehandlungsaktionen.
|
TroubleshootingResult
Problembehandlungsinformationen aus der angegebenen Ressource.
| Name |
Typ |
Beschreibung |
|
code
|
string
|
Der Ergebniscode der Problembehandlung.
|
|
endTime
|
string
|
Die Endzeit der Problembehandlung.
|
|
results
|
TroubleshootingDetails[]
|
Informationen zur Problembehandlung.
|
|
startTime
|
string
|
Die Startzeit der Problembehandlung.
|