@azure/arm-selfhelp package

Classes

HelpRP

Interfaces

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

Response for whether the requested resource name is available or not.

Diagnostic

Properties returned with in an insight.

DiagnosticInvocation

Solution Invocation with additional params needed for invocation.

DiagnosticResource

Diagnostic resource

Diagnostics

Interface representing a Diagnostics.

DiagnosticsCheckNameAvailabilityOptionalParams

Optional parameters.

DiagnosticsCreateOptionalParams

Optional parameters.

DiagnosticsGetOptionalParams

Optional parameters.

DiscoveryResponse

Discovery response.

DiscoverySolution

Interface representing a DiscoverySolution.

DiscoverySolutionListNextOptionalParams

Optional parameters.

DiscoverySolutionListOptionalParams

Optional parameters.

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. (This also follows the OData error response format.).

HelpRPOptionalParams

Optional parameters.

Insight

Detailed insights(s) obtained via the invocation of an insight diagnostic troubleshooter.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

SolutionMetadataResource

Solution Metadata resource

SystemData

Metadata pertaining to creation and last modification of the resource.

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DiagnosticsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

DiagnosticsCreateResponse

Contains response data for the create operation.

DiagnosticsGetResponse

Contains response data for the get operation.

DiscoverySolutionListNextResponse

Contains response data for the listNext operation.

DiscoverySolutionListResponse

Contains response data for the list operation.

ImportanceLevel

Defines values for ImportanceLevel.
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.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, 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.
Canceled: When Diagnostic request gets canceled.

Status

Defines values for Status.
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.

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownImportanceLevel

Known values of ImportanceLevel that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownStatus

Known values of Status that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.