Solution Self Help - Get

Service:

Help

API Version:

2024-03-01-preview

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.

GET https://management.azure.com/providers/Microsoft.Help/selfHelp/{solutionId}?api-version=2024-03-01-preview

URI Parameters

Name	In	Required	Type	Description
solutionId	path	True	string minLength: 1 maxLength: 100	SolutionId is a unique id to identify a solution. You can retrieve the solution id using the Discovery api - https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	SolutionResourceSelfHelp	Successful fetched solution result.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Solution_Get

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Help/selfHelp/SolutionId1?api-version=2024-03-01-preview

Java

/**
 * Samples for SolutionSelfHelp Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/SelfHelpSolution_Get.json
     */
    /**
     * Sample code: Solution_Get.
     * 
     * @param manager Entry point to SelfHelpManager.
     */
    public static void solutionGet(com.azure.resourcemanager.selfhelp.SelfHelpManager manager) {
        manager.solutionSelfHelps().getWithResponse("SolutionId1", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.selfhelp import SelfHelpMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-selfhelp
# USAGE
    python self_help_solution_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 = SelfHelpMgmtClient(
        credential=DefaultAzureCredential(),
    )

    response = client.solution_self_help.get(
        solution_id="SolutionId1",
    )
    print(response)


# x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/SelfHelpSolution_Get.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

Go

package armselfhelp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/selfhelp/armselfhelp/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c3cc9abe085093ba880ee3eeb792edb4fa789553/specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/SelfHelpSolution_Get.json
func ExampleSolutionSelfHelpClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armselfhelp.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSolutionSelfHelpClient().Get(ctx, "SolutionId1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.SolutionResourceSelfHelp = armselfhelp.SolutionResourceSelfHelp{
	// 	Name: to.Ptr("SolutionId1"),
	// 	Type: to.Ptr("Microsoft.Help/SelfHelp"),
	// 	ID: to.Ptr("/providers/Microsoft.KeyVault/vaults/test-keyvault-rp/providers/Microsoft.Help/selfHelp/SolutionId1"),
	// 	Properties: &armselfhelp.SolutionsResourcePropertiesSelfHelp{
	// 		Content: to.Ptr("<p>sample content</p>"),
	// 		ReplacementMaps: &armselfhelp.ReplacementMapsSelfHelp{
	// 			VideoGroups: []*armselfhelp.VideoGroup{
	// 				{
	// 					ReplacementKey: to.Ptr("<!--12345678-BBBb-cCCCC-0000-123456789012-->"),
	// 					Videos: []*armselfhelp.VideoGroupVideo{
	// 						{
	// 							Src: to.Ptr("sampleLink"),
	// 							Title: to.Ptr("widthtest"),
	// 					}},
	// 			}},
	// 			Videos: []*armselfhelp.Video{
	// 				{
	// 					Src: to.Ptr("sampleLink"),
	// 					Title: to.Ptr("CI - CD with Azure DevOps"),
	// 					ReplacementKey: to.Ptr("<!--12345678-BBBb-cCCCC-0000-123456789012-->"),
	// 			}},
	// 			WebResults: []*armselfhelp.WebResult{
	// 				{
	// 					ReplacementKey: to.Ptr("<!--12345678-BBBb-cCCCC-0000-123456789012-->"),
	// 					SearchResults: []*armselfhelp.SearchResult{
	// 						{
	// 							Confidence: to.Ptr(armselfhelp.ConfidenceHigh),
	// 							Content: to.Ptr("I sysprep a VM and now I cannot connect to it via <b>RDP</b>"),
	// 							Link: to.Ptr("sampleLink"),
	// 							Rank: to.Ptr[int32](1),
	// 							ResultType: to.Ptr(armselfhelp.ResultTypeCommunity),
	// 							SolutionID: to.Ptr("SolutionId1"),
	// 							Source: to.Ptr("sampleSource"),
	// 							Title: to.Ptr("Cannot RDP VM after SysPrep"),
	// 					}},
	// 			}},
	// 		},
	// 		Sections: []*armselfhelp.SectionSelfHelp{
	// 			{
	// 				Content: to.Ptr("<p>sample content</p>"),
	// 				ReplacementMaps: &armselfhelp.ReplacementMapsSelfHelp{
	// 				},
	// 				Title: to.Ptr("RBAC Authentication Common Solutions"),
	// 		}},
	// 		SolutionID: to.Ptr("sampleSolutionId"),
	// 		Title: to.Ptr("RBAC Authentication Common Solutions"),
	// 	},
	// }
}

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

JavaScript

const { HelpRP } = require("@azure/arm-selfhelp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/SelfHelpSolution_Get.json
 */
async function solutionGet() {
  const solutionId = "SolutionId1";
  const credential = new DefaultAzureCredential();
  const client = new HelpRP(credential);
  const result = await client.solutionSelfHelp.get(solutionId);
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SelfHelp.Models;
using Azure.ResourceManager.SelfHelp;

// Generated from example definition: specification/help/resource-manager/Microsoft.Help/preview/2024-03-01-preview/examples/SelfHelpSolution_Get.json
// this example is just showing the usage of "SolutionSelfHelp_Get" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation
string solutionId = "SolutionId1";
SelfHelpSolutionResult result = await tenantResource.GetSelfHelpSolutionByIdAsync(solutionId);

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

Status code:

200

{
  "id": "/providers/Microsoft.KeyVault/vaults/test-keyvault-rp/providers/Microsoft.Help/selfHelp/SolutionId1",
  "name": "SolutionId1",
  "type": "Microsoft.Help/SelfHelp",
  "properties": {
    "solutionId": "sampleSolutionId",
    "title": "RBAC Authentication Common Solutions",
    "content": "<p>sample content</p>",
    "replacementMaps": {
      "webResults": [
        {
          "replacementKey": "<!--12345678-BBBb-cCCCC-0000-123456789012-->",
          "searchResults": [
            {
              "solutionId": "SolutionId1",
              "content": "I sysprep a VM and now I cannot connect to it via <b>RDP</b>",
              "title": "Cannot RDP VM after SysPrep",
              "confidence": "High",
              "source": "sampleSource",
              "resultType": "Community",
              "rank": 1,
              "link": "sampleLink"
            }
          ]
        }
      ],
      "videos": [
        {
          "src": "sampleLink",
          "title": "CI - CD with Azure DevOps",
          "replacementKey": "<!--12345678-BBBb-cCCCC-0000-123456789012-->"
        }
      ],
      "videoGroups": [
        {
          "videos": [
            {
              "src": "sampleLink",
              "title": "widthtest"
            }
          ],
          "replacementKey": "<!--12345678-BBBb-cCCCC-0000-123456789012-->"
        }
      ]
    },
    "sections": [
      {
        "title": "RBAC Authentication Common Solutions",
        "content": "<p>sample content</p>",
        "replacementMaps": {}
      }
    ]
  }
}

Definitions

Name	Description
confidence	Confidence of the search result.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ReplacementMapsSelfHelp	Solution replacement maps.
resultType	Result type of the search result.
SearchResult	Details of an AzureKB search result.
SectionSelfHelp	Part of the solution and are dividers in the solution rendering.
SolutionResourceSelfHelp	Self Help Solution response.
systemData	Metadata pertaining to creation and last modification of the resource.
Video	Video detail
VideoGroup	Video group detail
VideoGroupVideo	VideoGroup video detail
WebResult	AzureKB web result

confidence

Enumeration

Confidence of the search result.

Value	Description
Low
Medium
High

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ReplacementMapsSelfHelp

Object

Solution replacement maps.

Name	Type	Description
videoGroups	VideoGroup[]	Group of Videos
videos	Video[]	Video solutions, which have the power to engage the customer by stimulating their senses
webResults	WebResult[]	Solution AzureKB results

resultType

Enumeration

Result type of the search result.

Value	Description
Community
Documentation

SearchResult

Object

Details of an AzureKB search result.

Name	Type	Description
confidence	confidence	Confidence of the search result.
content	string	Content of the search result.
link	string	Link to the document.
rank	integer (int32)	rank of the search result
resultType	resultType	Result type of the search result.
solutionId	string	Unique id of the result.
source	string	Source of the search result.
title	string	Title of the search result.

SectionSelfHelp

Object

Part of the solution and are dividers in the solution rendering.

Name	Type	Description
content	string	Solution sections content.
replacementMaps	ReplacementMapsSelfHelp	Solution replacement maps.
title	string	Solution sections title.

SolutionResourceSelfHelp

Object

Self Help Solution response.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.content	string	The HTML content that needs to be rendered and shown to customer.
properties.replacementMaps	ReplacementMapsSelfHelp	Solution replacement maps.
properties.sections	SectionSelfHelp[]	List of section object.
properties.solutionId	string	SolutionId is a unique id to identify a solution. You can retrieve the solution id using the Discovery api - https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP
properties.title	string	The title.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Video

Object

Video detail

Name	Type	Description
replacementKey	string	Place holder used in HTML Content replace control with the insight content
src	string	Link to the video
title	string	Title of the video

VideoGroup

Object

Video group detail

Name	Type	Description
replacementKey	string	Place holder used in HTML Content replace control with the insight content
videos	VideoGroupVideo[]	List of videos will be shown to customers

VideoGroupVideo

Object

VideoGroup video detail

Name	Type	Description
src	string	Link to the video
title	string	Title of the video

WebResult

Object

AzureKB web result

Name	Type	Description
replacementKey	string	Place holder used in HTML Content replace control with the content
searchResults	SearchResult[]	AzureKB search results