Share via


SelfHelpExtensions Class

Definition

A class to add extension methods to Azure.ResourceManager.SelfHelp.

public static class SelfHelpExtensions
type SelfHelpExtensions = class
Public Module SelfHelpExtensions
Inheritance
SelfHelpExtensions

Methods

CheckSelfHelpNameAvailability(ArmClient, ResourceIdentifier, SelfHelpNameAvailabilityContent, CancellationToken)

This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions

  • Request Path: /{scope}/providers/Microsoft.Help/checkNameAvailability
  • Operation Id: CheckNameAvailability_CheckAvailability
  • Default Api Version: 2024-03-01-preview
CheckSelfHelpNameAvailabilityAsync(ArmClient, ResourceIdentifier, SelfHelpNameAvailabilityContent, CancellationToken)

This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions

  • Request Path: /{scope}/providers/Microsoft.Help/checkNameAvailability
  • Operation Id: CheckNameAvailability_CheckAvailability
  • Default Api Version: 2024-03-01-preview
DiscoverSolutions(TenantResource, String, String, CancellationToken)

Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using problemClassification API) AND resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input : problemClassificationId (Use the problemClassification API) <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics and Solutions API.

  • Request Path: /providers/Microsoft.Help/discoverySolutions
  • Operation Id: DiscoverySolution_List
  • Default Api Version: 2024-03-01-preview
DiscoverSolutionsAsync(TenantResource, String, String, CancellationToken)

Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using problemClassification API) AND resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API, which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input : problemClassificationId (Use the problemClassification API) <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics and Solutions API.

  • Request Path: /providers/Microsoft.Help/discoverySolutions
  • Operation Id: DiscoverySolution_List
  • Default Api Version: 2024-03-01-preview
DiscoverSolutionsNlp(SubscriptionResource, DiscoveryNlpContent, CancellationToken)

Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Help/discoverSolutions
  • Operation Id: DiscoverySolutionNLP_DiscoverSolutionsBySubscription
  • Default Api Version: 2024-03-01-preview
DiscoverSolutionsNlp(TenantResource, DiscoveryNlpContent, CancellationToken)

Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary.

  • Request Path: /providers/Microsoft.Help/discoverSolutions
  • Operation Id: DiscoverySolutionNLP_DiscoverSolutions
  • Default Api Version: 2024-03-01-preview
DiscoverSolutionsNlpAsync(SubscriptionResource, DiscoveryNlpContent, CancellationToken)

Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary and subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Help/discoverSolutions
  • Operation Id: DiscoverySolutionNLP_DiscoverSolutionsBySubscription
  • Default Api Version: 2024-03-01-preview
DiscoverSolutionsNlpAsync(TenantResource, DiscoveryNlpContent, CancellationToken)

Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue summary.

  • Request Path: /providers/Microsoft.Help/discoverSolutions
  • Operation Id: DiscoverySolutionNLP_DiscoverSolutions
  • Default Api Version: 2024-03-01-preview
GetSelfHelpDiagnostic(ArmClient, ResourceIdentifier, String, CancellationToken)

Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.

  • Request Path: /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
  • Operation Id: Diagnostics_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SelfHelpDiagnosticResource
GetSelfHelpDiagnosticAsync(ArmClient, ResourceIdentifier, String, CancellationToken)

Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.

  • Request Path: /{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}
  • Operation Id: Diagnostics_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SelfHelpDiagnosticResource
GetSelfHelpDiagnosticResource(ArmClient, ResourceIdentifier)

Gets an object representing a SelfHelpDiagnosticResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create a SelfHelpDiagnosticResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetSelfHelpDiagnosticResource(ResourceIdentifier) instead.

GetSelfHelpDiagnostics(ArmClient, ResourceIdentifier)

Gets a collection of SelfHelpDiagnosticResources in the ArmClient. MockingTo mock this method, please mock GetSelfHelpDiagnostics(ResourceIdentifier) instead.

GetSelfHelpSimplifiedSolution(ArmClient, ResourceIdentifier, String, CancellationToken)

Get the simplified Solutions using the applicable solutionResourceName while creating the simplified Solutions.

  • Request Path: /{scope}/providers/Microsoft.Help/simplifiedSolutions/{simplifiedSolutionsResourceName}
  • Operation Id: SimplifiedSolutions_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SelfHelpSimplifiedSolutionResource
GetSelfHelpSimplifiedSolutionAsync(ArmClient, ResourceIdentifier, String, CancellationToken)

Get the simplified Solutions using the applicable solutionResourceName while creating the simplified Solutions.

  • Request Path: /{scope}/providers/Microsoft.Help/simplifiedSolutions/{simplifiedSolutionsResourceName}
  • Operation Id: SimplifiedSolutions_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SelfHelpSimplifiedSolutionResource
GetSelfHelpSimplifiedSolutionResource(ArmClient, ResourceIdentifier)

Gets an object representing a SelfHelpSimplifiedSolutionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create a SelfHelpSimplifiedSolutionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetSelfHelpSimplifiedSolutionResource(ResourceIdentifier) instead.

GetSelfHelpSimplifiedSolutions(ArmClient, ResourceIdentifier)

Gets a collection of SelfHelpSimplifiedSolutionResources in the ArmClient. MockingTo mock this method, please mock GetSelfHelpSimplifiedSolutions(ResourceIdentifier) instead.

GetSelfHelpSolution(ArmClient, ResourceIdentifier, String, CancellationToken)

Get the solution using the applicable solutionResourceName while creating the solution.

  • Request Path: /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
  • Operation Id: Solution_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SelfHelpSolutionResource
GetSelfHelpSolutionAsync(ArmClient, ResourceIdentifier, String, CancellationToken)

Get the solution using the applicable solutionResourceName while creating the solution.

  • Request Path: /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}
  • Operation Id: Solution_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SelfHelpSolutionResource
GetSelfHelpSolutionById(TenantResource, String, CancellationToken)

Gets Self Help Solutions for a given solutionId. Self Help Solutions consist of rich instructional video tutorials, links and guides to public documentation related to a specific problem that enables users to troubleshoot Azure issues.

  • Request Path: /providers/Microsoft.Help/selfHelp/{solutionId}
  • Operation Id: SolutionSelfHelp_Get
  • Default Api Version: 2024-03-01-preview
GetSelfHelpSolutionByIdAsync(TenantResource, String, CancellationToken)

Gets Self Help Solutions for a given solutionId. Self Help Solutions consist of rich instructional video tutorials, links and guides to public documentation related to a specific problem that enables users to troubleshoot Azure issues.

  • Request Path: /providers/Microsoft.Help/selfHelp/{solutionId}
  • Operation Id: SolutionSelfHelp_Get
  • Default Api Version: 2024-03-01-preview
GetSelfHelpSolutionResource(ArmClient, ResourceIdentifier)

Gets an object representing a SelfHelpSolutionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create a SelfHelpSolutionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetSelfHelpSolutionResource(ResourceIdentifier) instead.

GetSelfHelpSolutions(ArmClient, ResourceIdentifier)

Gets a collection of SelfHelpSolutionResources in the ArmClient. MockingTo mock this method, please mock GetSelfHelpSolutions(ResourceIdentifier) instead.

GetSelfHelpTroubleshooter(ArmClient, ResourceIdentifier, String, CancellationToken)

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
GetSelfHelpTroubleshooterAsync(ArmClient, ResourceIdentifier, String, CancellationToken)

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
GetSelfHelpTroubleshooterResource(ArmClient, ResourceIdentifier)

Gets an object representing a SelfHelpTroubleshooterResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create a SelfHelpTroubleshooterResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetSelfHelpTroubleshooterResource(ResourceIdentifier) instead.

GetSelfHelpTroubleshooters(ArmClient, ResourceIdentifier)

Gets a collection of SelfHelpTroubleshooterResources in the ArmClient. MockingTo mock this method, please mock GetSelfHelpTroubleshooters(ResourceIdentifier) instead.

Applies to