SelfHelpExtensions.GetTroubleshooterResourceAsync Method

Definition

Namespace:

Azure.ResourceManager.SelfHelp

Assembly:

Azure.ResourceManager.SelfHelp.dll

Package:

Azure.ResourceManager.SelfHelp v1.1.0-beta.2

Source:

SelfHelpExtensions.cs

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

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SelfHelp.TroubleshooterResource>> GetTroubleshooterResourceAsync (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope, string troubleshooterName, System.Threading.CancellationToken cancellationToken = default);

static member GetTroubleshooterResourceAsync : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.SelfHelp.TroubleshooterResource>>

<Extension()>
Public Function GetTroubleshooterResourceAsync (client As ArmClient, scope As ResourceIdentifier, troubleshooterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TroubleshooterResource))

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

Task<Response<TroubleshooterResource>>

Exceptions

ArgumentNullException

client or troubleshooterName is null.

ArgumentException

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