你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-selfhelp package

HelpRP

接口

AutomatedCheckResult

仅适用于 AutomatedStep 类型

CheckNameAvailabilityCheckAvailabilityOptionalParams

可选参数。

CheckNameAvailabilityOperations

表示 CheckNameAvailability 操作的接口。

CheckNameAvailabilityRequest

检查可用性请求正文。

CheckNameAvailabilityResponse

响应请求的资源名称是否可用。

ClassificationService

服务分类结果对象。

ContinueRequestBody

疑难解答 ContinueRequest 正文。

Diagnostic

见解中返回的属性。

DiagnosticInvocation

具有调用所需的附加参数的解决方案调用。

DiagnosticResource

诊断资源

DiagnosticResourceProperties

诊断资源属性。

DiagnosticsCreateOptionalParams

可选参数。

DiagnosticsGetOptionalParams

可选参数。

DiagnosticsOperations

表示诊断作的接口。

DiscoveryNlpRequest

发现 NLP 请求。

DiscoveryNlpResponse

已成功提取解决方案元数据的列表。

DiscoverySolutionListOptionalParams

可选参数。

DiscoverySolutionNLPDiscoverSolutionsBySubscriptionOptionalParams

可选参数。

DiscoverySolutionNLPDiscoverSolutionsOptionalParams

可选参数。

DiscoverySolutionNLPOperations

表示DiscoverySolutionNLP操作的接口。

DiscoverySolutionOperations

表示DiscoverySolution操作的接口。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorModel

错误定义。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。

ExtensionResource

基本扩展资源。

Filter

筛选条件

FilterGroup

筛选器组

HelpRPOptionalParams

客户端的可选参数。

Insight

通过调用见解诊断获取的详细见解

MetricsBasedChart

基于解决方案指标的图表

NlpSolutions

NLP元数据。

Operation

从资源提供程序操作 API 返回的 REST API 操作的详细信息

OperationDisplay

作的局部显示信息。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示作作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

一个允许异步可迭代的接口,以完成和按页面进行迭代。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

ReplacementMaps

解决方案替换映射。

ReplacementMapsSelfHelp

解决方案替换映射。

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

ResponseOption

资源的状态。

ResponseValidationProperties

故障排除步骤输入响应验证属性

RestartTroubleshooterResponse

疑难解答重启响应

RestorePollerOptions
SearchResult

AzureKB 搜索结果的详细信息。

Section

解决方案的一部分,是解决方案呈现中的分隔符。

SectionSelfHelp

解决方案的一部分,是解决方案呈现中的分隔符。

SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

SimplifiedSolutionsCreateOptionalParams

可选参数。

SimplifiedSolutionsGetOptionalParams

可选参数。

SimplifiedSolutionsOperations

表示 SimplifiedSolutions 操作的接口。

SimplifiedSolutionsResource

简化的解决方案响应。

SimplifiedSolutionsResourceProperties

简化的解决方案结果

SolutionCreateOptionalParams

可选参数。

SolutionGetOptionalParams

可选参数。

SolutionMetadataProperties

元数据属性

SolutionMetadataResource

元数据资源

SolutionNlpMetadataResource

Nlp 元数据资源

SolutionOperations

表示解决方案操作的接口。

SolutionPatchRequestBody

解决方案 PatchRequest 正文

SolutionResource

解决方案响应。

SolutionResourceProperties

解决方案结果

SolutionResourceSelfHelp

自助解决方案响应。

SolutionSelfHelpGetOptionalParams

可选参数。

SolutionSelfHelpOperations

表示解决方案的界面 自助操作。

SolutionUpdateOptionalParams

可选参数。

SolutionWarmUpOptionalParams

可选参数。

SolutionWarmUpRequestBody

解决方案 WarmUpRequest 正文

Solutions

解法列表

SolutionsDiagnostic

解决方案诊断

SolutionsResourcePropertiesSelfHelp

解决方案结果

SolutionsTroubleshooters

解决方案中的疑难解答

Step

疑难解答步骤

StepInput

步骤输入的详细信息。

SystemData

与创建和上次修改资源相关的元数据。

TriggerCriterion

解决方案请求触发器条件。 SolutionId/ProblemClassificationId 是解决方案 PUT 请求唯一支持的触发器类型。 ReplacementKey 是解决方案 PATCH 请求的唯一受支持的触发器类型。

TroubleshooterInstanceProperties

疑难解答实例属性。

TroubleshooterResource

疑难解答响应。

TroubleshooterResponse

疑难解答的用户响应继续请求

TroubleshootersContinueOptionalParams

可选参数。

TroubleshootersCreateOptionalParams

可选参数。

TroubleshootersEndOptionalParams

可选参数。

TroubleshootersGetOptionalParams

可选参数。

TroubleshootersOperations

代表故障排除人员操作的接口。

TroubleshootersRestartOptionalParams

可选参数。

Video

视频详细信息

VideoGroup

视频组详细信息

VideoGroupVideo

VideoGroup 视频详细信息

WebResult

AzureKB Web 结果

类型别名

ActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActionType 可与 ActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

内部:操作适用于仅限内部的 API。

AggregationType

允许的值为 Sum、Avg、Count、Min、Max。 默认是和
KnownAggregationType 可以与 AggregationType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

求和
Avg
计数
最小值
最大值

AutomatedCheckResultType

结果的类型。
KnownAutomatedCheckResultType 可以与 AutomatedCheckResultType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

成功
警告
错误
信息

AzureSupportedClouds

云设置为字符串文字类型的支持值

Confidence

搜索结果的置信度。
KnownConfidence 可以与 Confidence 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值


中等

ContinuablePage

描述结果页面的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体由用户创建。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体由托管标识创建。
:实体是由键创建的。

DiagnosticProvisioningState

诊断预配的状态。
KnownDiagnosticProvisioningState 可以与 DiagnosticProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

成功:Batch 中的所有诊断都成功。
PartialComplete:某些诊断仍在运行或失败。
失败:所有诊断都无法运行。
正在运行:所有诊断仍在运行。
已取消:当诊断请求被取消时。

ExecutionStatus

故障排除步骤执行的状态。
KnownExecutionStatus 可与 ExecutionStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

成功:步骤执行成功。
运行:步骤执行正在运行
失败:步骤执行失败
警告:步骤执行警告

ImportanceLevel

见解的重要性级别。
KnownImportanceLevel 可与 ImportanceLevel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

关键:运行诊断后已找到关键见解。
警告:运行诊断后已找到警告见解。
信息:运行诊断后已找到信息见解。

Name

触发器条件名称。
KnownName 可与 Name 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

解决方案 ID
问题分类 Id
替换键

Origin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”
KnownOrigin 可与 Origin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:指示操作是由用户启动的。
系统:指示操作是由系统启动的。
用户,系统:指示操作是由用户或系统启动的。

QuestionContentType

默认值为 Text。
KnownQuestionContentType 可以与 QuestionContentType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

文字
HTML全文
Markdown

QuestionType

问题类型
KnownQuestionType 可以与 QuestionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

RadioButton:SingleChoice 单选按钮
下拉列表:SingleChoice 下拉列表。
TextInput:文本输入
MultiLineInfoBox:MultiLineInfoBox
DateTimePicker:日期时间选取器
MultiSelect:多选

ResultType

搜索结果的结果类型。
KnownResultType 可以与 ResultType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

社区
文档

SolutionProvisioningState

解决方案预配的状态。
KnownSolutionProvisioningState 可以与 SolutionProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

成功:批处理中的所有解决方案都成功。
PartialComplete:某些解决方案仍在运行或失败。
失败:所有解决方案都无法运行。
正在运行:所有解决方案仍在运行。
已取消:当解决方案请求被取消时。

SolutionType

解决方案类型。
KnownSolutionType 可以与 SolutionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

诊断:诊断资源类型。
解决方案:解决方案资源类型。
疑难解答:疑难解答资源类型。
自助:自助资源类型。

Status

表示诊断资源的状态。
KnownStatus 可与 Status 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

失败:诊断创建失败。
MissingInputs:请求缺少运行所需的输入。
运行:诊断仍在运行。
成功:诊断创建成功。
超时:诊断超时。

TroubleshooterProvisioningState

故障排除程序预配的状态。
KnownTroubleshooterProvisioningState 可以与 TroubleshooterProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

成功
失败
已取消
正在运行
自动继续

Type

故障排除步骤的类型。
KnownType 可与 Type 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

决策
解决方案
见解
自动检查
输入

ValidationScope

验证范围
KnownValidationScope 可以与 ValidationScope 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

没有
网址文件
指南格式
Ip地址格式
NumberOnly格式

枚举

AzureClouds

一个用来描述Azure云环境的enum。

KnownActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。

KnownAggregationType

允许的值为 Sum、Avg、Count、Min、Max。 默认值为 Sum

KnownAutomatedCheckResultType

结果的类型。

KnownConfidence

搜索结果的置信度。

KnownCreatedByType

创建资源的实体类型。

KnownDiagnosticProvisioningState

诊断预配的状态。

KnownExecutionStatus

故障排除步骤执行的状态。

KnownImportanceLevel

见解的重要性级别。

KnownName

触发器条件名称。

KnownOrigin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”

KnownQuestionContentType

默认值为 Text。

KnownQuestionType

问题类型

KnownResultType

搜索结果的结果类型。

KnownSolutionProvisioningState

解决方案预配的状态。

KnownSolutionType

解决方案类型。

KnownStatus

表示诊断资源的状态。

KnownTroubleshooterProvisioningState

故障排除程序预配的状态。

KnownType

故障排除步骤的类型。

KnownValidationScope

验证范围

KnownVersions

可用的 API 版本。

函数

isRestError(unknown)

RestError 的 Typeguard

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

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

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

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

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

参数

client
HelpRP
serializedState

string

sourceOperation

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

返回

PollerLike<OperationState<TResult>, TResult>

变量详细信息

RestError

失败管道请求的自定义错误类型。

RestError: RestErrorConstructor

类型