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

@azure/arm-workloadorchestration package

WorkloadOrchestrationManagementClient

接口

AvailableSolutionTemplateVersion

可用的解决方案模板版本以及最新版本

BulkDeploySolutionParameter

批量部署解决方案参数

BulkDeployTargetDetails

批量部署目标详细信息

BulkPublishSolutionParameter

批量发布解决方案参数

BulkPublishTargetDetails

批量发布目标详细信息

Capability

功能,在解决方案模板和目标中匹配

ComponentStatus

组件状态

ConfigTemplate

配置模板资源。 包含使用预定义表达式语言的配置表达式。

ConfigTemplateProperties

配置模板属性

ConfigTemplateUpdate

用于更新 ConfigTemplate作的类型。

ConfigTemplateUpdateProperties

ConfigTemplate 的可更新属性。

ConfigTemplateVersion

配置模板版本资源

ConfigTemplateVersionProperties

配置模板版本属性

ConfigTemplateVersionWithUpdateType

具有更新类型的配置模板版本

ConfigTemplateVersionsGetOptionalParams

可选参数。

ConfigTemplateVersionsListByConfigTemplateOptionalParams

可选参数。

ConfigTemplateVersionsOperations

表示 ConfigTemplateVersions作的接口。

ConfigTemplatesCreateOrUpdateOptionalParams

可选参数。

ConfigTemplatesCreateVersionOptionalParams

可选参数。

ConfigTemplatesDeleteOptionalParams

可选参数。

ConfigTemplatesGetOptionalParams

可选参数。

ConfigTemplatesListByResourceGroupOptionalParams

可选参数。

ConfigTemplatesListBySubscriptionOptionalParams

可选参数。

ConfigTemplatesOperations

表示 ConfigTemplates作的接口。

ConfigTemplatesRemoveVersionOptionalParams

可选参数。

ConfigTemplatesUpdateOptionalParams

可选参数。

Context

上下文资源

ContextProperties

上下文属性

ContextUpdate

用于上下文更新作的类型。

ContextUpdateProperties

上下文的可更新属性。

ContextsCreateOrUpdateOptionalParams

可选参数。

ContextsDeleteOptionalParams

可选参数。

ContextsGetOptionalParams

可选参数。

ContextsListByResourceGroupOptionalParams

可选参数。

ContextsListBySubscriptionOptionalParams

可选参数。

ContextsOperations

表示上下文作的接口。

ContextsUpdateOptionalParams

可选参数。

DeployJobParameter

部署作业的参数。

DeployJobStepStatistics

部署作业步骤的统计信息,包括总计数、成功计数和失败计数。

DeploymentStatus

部署状态

Diagnostic

诊断资源。

DiagnosticProperties

诊断资源的属性。

DiagnosticUpdate

用于诊断更新作的类型。

DiagnosticUpdateProperties

诊断的可更新属性。

DiagnosticsCreateOrUpdateOptionalParams

可选参数。

DiagnosticsDeleteOptionalParams

可选参数。

DiagnosticsGetOptionalParams

可选参数。

DiagnosticsListByResourceGroupOptionalParams

可选参数。

DiagnosticsListBySubscriptionOptionalParams

可选参数。

DiagnosticsOperations

表示诊断作的接口。

DiagnosticsUpdateOptionalParams

可选参数。

DynamicSchema

DynamicSchema 资源

DynamicSchemaProperties

DynamicSchema 属性

DynamicSchemaVersion

动态架构版本资源

DynamicSchemaVersionsCreateOrUpdateOptionalParams

可选参数。

DynamicSchemaVersionsDeleteOptionalParams

可选参数。

DynamicSchemaVersionsGetOptionalParams

可选参数。

DynamicSchemaVersionsListByDynamicSchemaOptionalParams

可选参数。

DynamicSchemaVersionsOperations

表示 DynamicSchemaVersions作的接口。

DynamicSchemaVersionsUpdateOptionalParams

可选参数。

DynamicSchemasCreateOrUpdateOptionalParams

可选参数。

DynamicSchemasDeleteOptionalParams

可选参数。

DynamicSchemasGetOptionalParams

可选参数。

DynamicSchemasListBySchemaOptionalParams

可选参数。

DynamicSchemasOperations

表示 DynamicSchemas作的接口。

DynamicSchemasUpdateOptionalParams

可选参数。

ErrorAction

错误作属性

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

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

Execution

执行资源

ExecutionProperties

执行属性

ExecutionStatus

执行状态

ExecutionsCreateOrUpdateOptionalParams

可选参数。

ExecutionsDeleteOptionalParams

可选参数。

ExecutionsGetOptionalParams

可选参数。

ExecutionsListByWorkflowVersionOptionalParams

可选参数。

ExecutionsOperations

表示执行作的接口。

ExecutionsUpdateOptionalParams

可选参数。

ExtendedLocation

扩展位置的复杂类型。

ExtensionResource

基本扩展资源。

Hierarchy

Hierarchy,以使用站点/层次结构提供程序节点表示的内容来标记节点

InstallSolutionParameter

安装解决方案参数

Instance

实例资源。 表示部署对象。

InstanceHistoriesGetOptionalParams

可选参数。

InstanceHistoriesListByInstanceOptionalParams

可选参数。

InstanceHistoriesOperations

表示 InstanceHistories作的接口。

InstanceHistory

InstanceHistory 资源

InstanceHistoryProperties

实例历史记录属性

InstanceProperties

实例属性

InstancesCreateOrUpdateOptionalParams

可选参数。

InstancesDeleteOptionalParams

可选参数。

InstancesGetOptionalParams

可选参数。

InstancesListBySolutionOptionalParams

可选参数。

InstancesOperations

表示实例作的接口。

InstancesUpdateOptionalParams

可选参数。

Job

用于跟踪作业执行和子状态的作业扩展资源。

JobParameterBase

基本作业参数

JobProperties

作业资源的属性,包括类型、状态、参数、步骤和错误详细信息。

JobStep

作业步骤

JobStepStatisticsBase

基本作业步骤统计

JobsGetOptionalParams

可选参数。

JobsListByTargetOptionalParams

可选参数。

JobsOperations

表示作业作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

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

ProxyResource

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

ReconciliationPolicyProperties

定义 ReconciliationPolicy

RemoveRevisionParameter

安装解决方案参数

RemoveVersionResponse

删除版本响应

ResolvedConfiguration

已解决的配置

Resource

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

RestorePollerOptions
Schema

架构资源

SchemaProperties

架构属性

SchemaReference

架构参考资源

SchemaReferenceProperties

架构引用属性

SchemaReferencesGetOptionalParams

可选参数。

SchemaReferencesListByResourceGroupOptionalParams

可选参数。

SchemaReferencesOperations

表示 SchemaReferences作的接口。

SchemaUpdate

用于架构更新作的类型。

SchemaUpdateProperties

架构的可更新属性。

SchemaVersion

架构版本资源

SchemaVersionProperties

架构版本属性

SchemaVersionWithUpdateType

具有更新类型的架构版本

SchemaVersionsCreateOrUpdateOptionalParams

可选参数。

SchemaVersionsDeleteOptionalParams

可选参数。

SchemaVersionsGetOptionalParams

可选参数。

SchemaVersionsListBySchemaOptionalParams

可选参数。

SchemaVersionsOperations

表示 SchemaVersions作的接口。

SchemaVersionsUpdateOptionalParams

可选参数。

SchemasCreateOrUpdateOptionalParams

可选参数。

SchemasCreateVersionOptionalParams

可选参数。

SchemasDeleteOptionalParams

可选参数。

SchemasGetOptionalParams

可选参数。

SchemasListByResourceGroupOptionalParams

可选参数。

SchemasListBySubscriptionOptionalParams

可选参数。

SchemasOperations

表示 Schemas作的接口。

SchemasRemoveVersionOptionalParams

可选参数。

SchemasUpdateOptionalParams

可选参数。

SiteReference

站点参考资源

SiteReferenceProperties

场地参考属性

SiteReferencesCreateOrUpdateOptionalParams

可选参数。

SiteReferencesDeleteOptionalParams

可选参数。

SiteReferencesGetOptionalParams

可选参数。

SiteReferencesListByContextOptionalParams

可选参数。

SiteReferencesOperations

表示 SiteReferences作的接口。

SiteReferencesUpdateOptionalParams

可选参数。

Solution

附加到目标的解决方案资源

SolutionDependency

解决方案依赖项上下文

SolutionDependencyParameter

解决方案依赖项上下文

SolutionProperties

解决方案属性

SolutionTemplate

解决方案模板资源。 包含用于创建版本的功能和作。

SolutionTemplateParameter

解决方案模板参数

SolutionTemplateProperties

解决方案模板属性

SolutionTemplateUpdate

用于 SolutionTemplate 的更新作的类型。

SolutionTemplateUpdateProperties

SolutionTemplate 的可更新属性。

SolutionTemplateVersion

解决方案模板版本资源。 包含使用表达式的配置,这些表达式可以与边规范一起分层解析。

SolutionTemplateVersionProperties

解决方案模板版本属性

SolutionTemplateVersionWithUpdateType

具有更新类型的解决方案模板版本

SolutionTemplateVersionsBulkDeploySolutionOptionalParams

可选参数。

SolutionTemplateVersionsBulkPublishSolutionOptionalParams

可选参数。

SolutionTemplateVersionsGetOptionalParams

可选参数。

SolutionTemplateVersionsListBySolutionTemplateOptionalParams

可选参数。

SolutionTemplateVersionsOperations

表示 SolutionTemplateVersions作的接口。

SolutionTemplatesCreateOrUpdateOptionalParams

可选参数。

SolutionTemplatesCreateVersionOptionalParams

可选参数。

SolutionTemplatesDeleteOptionalParams

可选参数。

SolutionTemplatesGetOptionalParams

可选参数。

SolutionTemplatesListByResourceGroupOptionalParams

可选参数。

SolutionTemplatesListBySubscriptionOptionalParams

可选参数。

SolutionTemplatesOperations

表示 SolutionTemplates作的接口。

SolutionTemplatesRemoveVersionOptionalParams

可选参数。

SolutionTemplatesUpdateOptionalParams

可选参数。

SolutionUpdate

用于解决方案更新作的类型。

SolutionUpdateProperties

解决方案的可更新属性。

SolutionVersion

解决方案版本资源。 它具有已解析的配置以及边缘规范。

SolutionVersionParameter

解决方案版本参数

SolutionVersionProperties

解决方案版本属性

SolutionVersionSnapshot

解决方案版本快照

SolutionVersionsCreateOrUpdateOptionalParams

可选参数。

SolutionVersionsDeleteOptionalParams

可选参数。

SolutionVersionsGetOptionalParams

可选参数。

SolutionVersionsListBySolutionOptionalParams

可选参数。

SolutionVersionsOperations

表示 SolutionVersions作的接口。

SolutionVersionsUpdateOptionalParams

可选参数。

SolutionsCreateOrUpdateOptionalParams

可选参数。

SolutionsDeleteOptionalParams

可选参数。

SolutionsGetOptionalParams

可选参数。

SolutionsListByTargetOptionalParams

可选参数。

SolutionsOperations

表示解决方案作的接口。

SolutionsUpdateOptionalParams

可选参数。

StageSpec

舞台属性

StageStatus

阶段执行的结果

SystemData

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

Target

目标资源。 表示要部署在边缘上的资源。

TargetProperties

目标属性

TargetSnapshot

目标快照

TargetStatus

目标状态

TargetUpdate

用于目标更新作的类型。

TargetUpdateProperties

目标的可更新属性。

TargetsCreateOrUpdateOptionalParams

可选参数。

TargetsDeleteOptionalParams

可选参数。

TargetsGetOptionalParams

可选参数。

TargetsInstallSolutionOptionalParams

可选参数。

TargetsListByResourceGroupOptionalParams

可选参数。

TargetsListBySubscriptionOptionalParams

可选参数。

TargetsOperations

表示目标作的接口。

TargetsPublishSolutionVersionOptionalParams

可选参数。

TargetsRemoveRevisionOptionalParams

可选参数。

TargetsResolveConfigurationOptionalParams

可选参数。

TargetsReviewSolutionVersionOptionalParams

可选参数。

TargetsUninstallSolutionOptionalParams

可选参数。

TargetsUpdateExternalValidationStatusOptionalParams

可选参数。

TargetsUpdateOptionalParams

可选参数。

TaskOption

任务选项属性

TaskSpec

任务规范

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

UninstallSolutionParameter

卸载解决方案参数

UpdateExternalValidationStatusParameter

更新外部验证状态参数

VersionParameter

版本参数

Workflow

工作流资源

WorkflowProperties

工作流属性

WorkflowVersion

工作流版本资源

WorkflowVersionProperties

工作流版本属性

WorkflowVersionsCreateOrUpdateOptionalParams

可选参数。

WorkflowVersionsDeleteOptionalParams

可选参数。

WorkflowVersionsGetOptionalParams

可选参数。

WorkflowVersionsListByWorkflowOptionalParams

可选参数。

WorkflowVersionsOperations

表示 WorkflowVersions作的接口。

WorkflowVersionsUpdateOptionalParams

可选参数。

WorkflowsCreateOrUpdateOptionalParams

可选参数。

WorkflowsDeleteOptionalParams

可选参数。

WorkflowsGetOptionalParams

可选参数。

WorkflowsListByContextOptionalParams

可选参数。

WorkflowsOperations

表示工作流作的接口。

WorkflowsUpdateOptionalParams

可选参数。

WorkloadOrchestrationManagementClientOptionalParams

客户端的可选参数。

类型别名

ActiveState

实例状态
KnownActiveState 可以与 ActiveState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

active:实例处于活动状态
inactive:实例处于非活动状态

AzureSupportedClouds

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

ConfigurationModel

可用的配置模型
KnownConfigurationModel 可以与 ConfigurationModel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

应用:配置模型应用
通用:配置模型通用

ConfigurationType

可用的配置类型
KnownConfigurationType 可以与 ConfigurationType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

共享:配置类型共享
层次结构:配置类型层次结构

ContinuablePage

描述结果页面的接口。

CreatedByType

创建资源的实体类型。
<xref:KnowncreatedByType> 可以与 createdByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

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

ErrorActionMode

错误作模式
KnownErrorActionMode 可以与 ErrorActionMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

stopOnAnyFailure:任何失败时停止
stopOnNFailures:N 次累积故障后停止
silentlyContinue:尽管有错误,仍静默继续

ExtendedLocationType

支持的 ExtendedLocation 类型。
KnownExtendedLocationType 可以与 ExtendedLocationType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

EdgeZone:Azure 边缘区域位置类型
CustomLocation:Azure 自定义位置类型

JobParameterBaseUnion

JobParameterBaseUnion 的别名

JobStatus

作业或作业步骤的状态。
KnownJobStatus 可以与 JobStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

启动:作业或步骤未启动。
InProgress:作业或步骤正在进行中。
成功:作业或步骤成功。
失败:作业或步骤失败。

JobStepStatisticsBaseUnion

JobStepStatisticsBaseUnion 的别名

JobType

JobType 的作业类型。 支持通过字符串值进行扩展。
KnownJobType 可以与 JobType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

deploy:部署作业。
暂存:暂存作业。
externalValidation:验证作业。

OrchestratorType

可用的 Orchestrator 类型
KnownOrchestratorType 可以与 OrchestratorType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

TO:默认类型

ProvisioningState

资源的预配状态
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

已成功:已创建资源。
失败:资源创建失败。
已取消:资源创建已取消。
初始化:资源配置已初始化
InProgress:资源预配正在进行中
正在删除:资源预配正在删除

ReconciliationState

定义对帐策略的状态。
KnownReconciliationState 可以与 ReconciliationState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

inactive:对帐处于非活动状态
active:对帐处于活动状态

ResourceState

资源类型状态
KnownResourceState 可以与 ResourceState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

active:资源处于活动状态
inactive:资源处于非活动状态

State

解决方案实例状态
KnownState 可以与 State 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

InReview:解决方案实例正在审核中
UpgradeInReview:正在审查解决方案实例升级
ReadyToDeploy:解决方案实例已准备好部署
ReadyToUpgrade:解决方案实例已准备好升级
正在部署:解决方案实例正在部署
部署:已部署解决方案实例
失败:解决方案实例部署失败
未部署:解决方案实例已取消部署
PendingExternalValidation:解决方案实例正在等待外部验证
ExternalValidationFailed:解决方案实例外部验证失败
暂存:解决方案实例正在暂存映像

UpdateType

表示将更新版本号的哪一部分
KnownUpdateType 可以与 UpdateType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

主要:主要版本
次要:次要版本
补丁:补丁版本

ValidationStatus

解决方案实例验证状态
KnownValidationStatus 可以与 ValidationStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

有效:解决方案实例有效
无效:解决方案实例无效

枚举

AzureClouds

用于描述 Azure 云的枚举。

KnownActiveState

实例状态

KnownConfigurationModel

可用的配置模型

KnownConfigurationType

可用的配置类型

KnownCreatedByType

创建资源的实体类型。

KnownErrorActionMode

错误作模式

KnownExtendedLocationType

支持的 ExtendedLocation 类型。

KnownJobStatus

作业或作业步骤的状态。

KnownJobType

JobType 的作业类型。 支持通过字符串值进行扩展。

KnownOrchestratorType

可用的 Orchestrator 类型

KnownProvisioningState

资源的预配状态

KnownReconciliationState

定义对帐策略的状态。

KnownResourceState

资源类型状态

KnownState

解决方案实例状态

KnownUpdateType

表示将更新版本号的哪一部分

KnownValidationStatus

解决方案实例验证状态

KnownVersions

可用的 API 版本。

函数

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

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

函数详细信息

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

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

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

参数

serializedState

string

sourceOperation

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

返回

PollerLike<OperationState<TResult>, TResult>