Share via


SelfHelpExtensions.GetSelfHelpTroubleshooter Method

Definition

Gets troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.<br/> Get API is used to retrieve the result of a Troubleshooter instance, which includes the status and result of each step in the Troubleshooter workflow. This API requires the Troubleshooter resource name that was created using the Create API.

  • Request Path: /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}
  • Operation Id: Troubleshooters_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SelfHelpTroubleshooterResource
public static Azure.Response<Azure.ResourceManager.SelfHelp.SelfHelpTroubleshooterResource> GetSelfHelpTroubleshooter (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, string troubleshooterName, System.Threading.CancellationToken cancellationToken = default);
static member GetSelfHelpTroubleshooter : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.SelfHelp.SelfHelpTroubleshooterResource>
<Extension()>
Public Function GetSelfHelpTroubleshooter (client As ArmClient, scope As ResourceIdentifier, troubleshooterName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SelfHelpTroubleshooterResource)

Parameters

client
ArmClient

The ArmClient instance the method will execute against.

scope
ResourceIdentifier

The scope that the resource will apply against.

troubleshooterName
String

Troubleshooter resource Name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

client or troubleshooterName is null.

troubleshooterName is an empty string, and was expected to be non-empty.

Applies to