@azure/arm-selfhelp package

Classes

HelpRP

Interfaces

AutomatedCheckResult	Only for AutomatedStep type
CheckNameAvailabilityCheckAvailabilityOptionalParams	Optional parameters.
CheckNameAvailabilityOperations	Interface representing a CheckNameAvailability operations.
CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	Response for whether the requested resource name is available or not.
ClassificationService	Service Classification result object.
ContinueRequestBody	Troubleshooter ContinueRequest body.
Diagnostic	Properties returned with in an insight.
DiagnosticInvocation	Solution Invocation with additional params needed for invocation.
DiagnosticResource	Diagnostic resource
DiagnosticResourceProperties	Diagnostic resource properties.
DiagnosticsCreateOptionalParams	Optional parameters.
DiagnosticsGetOptionalParams	Optional parameters.
DiagnosticsOperations	Interface representing a Diagnostics operations.
DiscoveryNlpRequest	Discover NLP request.
DiscoveryNlpResponse	Successfully fetched list of solution metadata.
DiscoverySolutionListOptionalParams	Optional parameters.
DiscoverySolutionNLPDiscoverSolutionsBySubscriptionOptionalParams	Optional parameters.
DiscoverySolutionNLPDiscoverSolutionsOptionalParams	Optional parameters.
DiscoverySolutionNLPOperations	Interface representing a DiscoverySolutionNLP operations.
DiscoverySolutionOperations	Interface representing a DiscoverySolution operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorModel	Error definition.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExtensionResource	The base extension resource.
Filter	Filter criterion
FilterGroup	Filter group
HelpRPOptionalParams	Optional parameters for the client.
Insight	Detailed insights(s) obtained via the invocation of an insight diagnostic
MetricsBasedChart	Solutions metrics based chart
NlpSolutions	Nlp metadata.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
ReplacementMaps	Solution replacement maps.
ReplacementMapsSelfHelp	Solution replacement maps.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResponseOption	The status of the resource.
ResponseValidationProperties	Troubleshooter step input response validation properties
RestartTroubleshooterResponse	Troubleshooter restart response
RestorePollerOptions
SearchResult	Details of an AzureKB search result.
Section	Part of the solution and are dividers in the solution rendering.
SectionSelfHelp	Part of the solution and are dividers in the solution rendering.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SimplifiedSolutionsCreateOptionalParams	Optional parameters.
SimplifiedSolutionsGetOptionalParams	Optional parameters.
SimplifiedSolutionsOperations	Interface representing a SimplifiedSolutions operations.
SimplifiedSolutionsResource	Simplified Solutions response.
SimplifiedSolutionsResourceProperties	Simplified Solutions result
SolutionCreateOptionalParams	Optional parameters.
SolutionGetOptionalParams	Optional parameters.
SolutionMetadataProperties	Metadata Properties
SolutionMetadataResource	Metadata resource
SolutionNlpMetadataResource	Nlp Metadata resource
SolutionOperations	Interface representing a Solution operations.
SolutionPatchRequestBody	Solution PatchRequest body
SolutionResource	Solution response.
SolutionResourceProperties	Solution result
SolutionResourceSelfHelp	Self Help Solution response.
SolutionSelfHelpGetOptionalParams	Optional parameters.
SolutionSelfHelpOperations	Interface representing a SolutionSelfHelp operations.
SolutionUpdateOptionalParams	Optional parameters.
SolutionWarmUpOptionalParams	Optional parameters.
SolutionWarmUpRequestBody	Solution WarmUpRequest body
Solutions	List of solutions
SolutionsDiagnostic	Solutions Diagnostic
SolutionsResourcePropertiesSelfHelp	Solution result
SolutionsTroubleshooters	Troubleshooters in Solutions
Step	Troubleshooter step
StepInput	Details of step input.
SystemData	Metadata pertaining to creation and last modification of the resource.
TriggerCriterion	Solution request trigger criterion. SolutionId/ProblemClassificationId is the only supported trigger type for Solution PUT request. ReplacementKey is the only supported trigger type for Solution PATCH request.
TroubleshooterInstanceProperties	Troubleshooter Instance properties.
TroubleshooterResource	Troubleshooter response.
TroubleshooterResponse	User Response for Troubleshooter continue request
TroubleshootersContinueOptionalParams	Optional parameters.
TroubleshootersCreateOptionalParams	Optional parameters.
TroubleshootersEndOptionalParams	Optional parameters.
TroubleshootersGetOptionalParams	Optional parameters.
TroubleshootersOperations	Interface representing a Troubleshooters operations.
TroubleshootersRestartOptionalParams	Optional parameters.
Video	Video detail
VideoGroup	Video group detail
VideoGroupVideo	VideoGroup video detail
WebResult	AzureKB web result

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AggregationType	Allowed values are Sum, Avg, Count, Min, Max. Default is Sum KnownAggregationType can be used interchangeably with AggregationType, this enum contains the known values that the service supports. Known values supported by the service Sum Avg Count Min Max
AutomatedCheckResultType	Type of Result. KnownAutomatedCheckResultType can be used interchangeably with AutomatedCheckResultType, this enum contains the known values that the service supports. Known values supported by the service Success Warning Error Information
AzureSupportedClouds	The supported values for cloud setting as a string literal type
Confidence	Confidence of the search result. KnownConfidence can be used interchangeably with Confidence, this enum contains the known values that the service supports. Known values supported by the service Low Medium High
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DiagnosticProvisioningState	Status of diagnostic provisioning. KnownDiagnosticProvisioningState can be used interchangeably with DiagnosticProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: All Diagnostics in the Batch succeeded. PartialComplete: Some Diagnostics are still running or failed. Failed: All Diagnostics failed to run. Running: All Diagnostics are still running. Canceled: When Diagnostic request gets canceled.
ExecutionStatus	Status of Troubleshooter Step execution. KnownExecutionStatus can be used interchangeably with ExecutionStatus, this enum contains the known values that the service supports. Known values supported by the service Success: Step execution succeeded. Running: Step execution running Failed: Step execution failed Warning: Step execution warning
ImportanceLevel	Importance level of the insight. KnownImportanceLevel can be used interchangeably with ImportanceLevel, this enum contains the known values that the service supports. Known values supported by the service Critical: A critical insight has been found after running the diagnostic. Warning: A warning insight has been found after running the diagnostic. Information: An information insight has been found after running the diagnostic.
Name	Trigger criterion name. KnownName can be used interchangeably with Name, this enum contains the known values that the service supports. Known values supported by the service SolutionId ProblemClassificationId ReplacementKey
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
QuestionContentType	Default is Text. KnownQuestionContentType can be used interchangeably with QuestionContentType, this enum contains the known values that the service supports. Known values supported by the service Text Html Markdown
QuestionType	Type of Question KnownQuestionType can be used interchangeably with QuestionType, this enum contains the known values that the service supports. Known values supported by the service RadioButton: SingleChoice radio button Dropdown: SingleChoice dropdown. TextInput: Text Input MultiLineInfoBox: MultiLineInfoBox DateTimePicker: DateTime Picker MultiSelect: Multi Select
ResultType	Result type of the search result. KnownResultType can be used interchangeably with ResultType, this enum contains the known values that the service supports. Known values supported by the service Community Documentation
SolutionProvisioningState	Status of solution provisioning. KnownSolutionProvisioningState can be used interchangeably with SolutionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: All Solutions in the Batch succeeded. PartialComplete: Some Solutions are still running or failed. Failed: All Solutions failed to run. Running: All Solutions are still running. Canceled: When Solutions request gets canceled.
SolutionType	Solution Type. KnownSolutionType can be used interchangeably with SolutionType, this enum contains the known values that the service supports. Known values supported by the service Diagnostics: Diagnostics resource type. Solutions: Solutions resource type. Troubleshooters: Troubleshooters resource type. SelfHelp: SelfHelp resource type.
Status	Denotes the status of the diagnostic resource. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service Failed: Diagnostic creation failed. MissingInputs: Request is missing required inputs to run. Running: Diagnostic is still running. Succeeded: Diagnostic creation succeeded. Timeout: Diagnostic was timed out.
TroubleshooterProvisioningState	Status of troubleshooter provisioning. KnownTroubleshooterProvisioningState can be used interchangeably with TroubleshooterProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Canceled Running AutoContinue
Type	Type of Troubleshooting step. KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service Decision Solution Insight AutomatedCheck Input
ValidationScope	Validation scope KnownValidationScope can be used interchangeably with ValidationScope, this enum contains the known values that the service supports. Known values supported by the service None URLFormat GuidFormat IpAddressFormat NumberOnlyFormat

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAggregationType	Allowed values are Sum, Avg, Count, Min, Max. Default is Sum
KnownAutomatedCheckResultType	Type of Result.
KnownConfidence	Confidence of the search result.
KnownCreatedByType	The kind of entity that created the resource.
KnownDiagnosticProvisioningState	Status of diagnostic provisioning.
KnownExecutionStatus	Status of Troubleshooter Step execution.
KnownImportanceLevel	Importance level of the insight.
KnownName	Trigger criterion name.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownQuestionContentType	Default is Text.
KnownQuestionType	Type of Question
KnownResultType	Result type of the search result.
KnownSolutionProvisioningState	Status of solution provisioning.
KnownSolutionType	Solution Type.
KnownStatus	Denotes the status of the diagnostic resource.
KnownTroubleshooterProvisioningState	Status of troubleshooter provisioning.
KnownType	Type of Troubleshooting step.
KnownValidationScope	Validation scope
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(HelpRP, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(HelpRP, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: HelpRP, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

HelpRP

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor