@azure/arm-workloadorchestration package

類別

WorkloadOrchestrationManagementClient

介面

AvailableSolutionTemplateVersion

可用的解決方案範本版本以及最新版本

BulkDeploySolutionParameter

大量部署解決方案參數

BulkDeployTargetDetails

大量部署目標詳細資料

BulkPublishSolutionParameter

大量發佈解決方案參數

BulkPublishTargetDetails

大量發佈目標詳細資料

Capability

功能,以在解決方案範本和目標中比對

ComponentStatus

元件狀態

ConfigTemplate

Config 範本資源。 包含使用預先定義運算式語言的組態運算式。

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 Resource Manager API 的常見錯誤回應,以傳回失敗作業的錯誤詳細數據。

Execution

執行資源

ExecutionProperties

執行屬性

ExecutionStatus

執行狀態

ExecutionsCreateOrUpdateOptionalParams

選擇性參數。

ExecutionsDeleteOptionalParams

選擇性參數。

ExecutionsGetOptionalParams

選擇性參數。

ExecutionsListByWorkflowVersionOptionalParams

選擇性參數。

ExecutionsOperations

代表執行作業的介面。

ExecutionsUpdateOptionalParams

選擇性參數。

ExtendedLocation

擴充位置的複雜類型。

ExtensionResource

基底延伸模組資源。

Hierarchy

Hierarchy,以使用其代表的內容來標記 Sites/Hierarchy Provider 節點

InstallSolutionParameter

安裝解決方案參數

Instance

執行個體資源。 代表部署物件。

InstanceHistoriesGetOptionalParams

選擇性參數。

InstanceHistoriesListByInstanceOptionalParams

選擇性參數。

InstanceHistoriesOperations

代表 InstanceHistories 作業的介面。

InstanceHistory

InstanceHistory 資源

InstanceHistoryProperties

實例歷程記錄屬性

InstanceProperties

實例屬性

InstancesCreateOrUpdateOptionalParams

選擇性參數。

InstancesDeleteOptionalParams

選擇性參數。

InstancesGetOptionalParams

選擇性參數。

InstancesListBySolutionOptionalParams

選擇性參數。

InstancesOperations

代表實例作業的介面。

InstancesUpdateOptionalParams

選擇性參數。

Job

用於追蹤工作執行和子狀態的作業延伸資源。

JobParameterBase

基本工作參數

JobProperties

工作資源的屬性,包括類型、狀態、參數、步驟和錯誤詳細資料。

JobStep

工作步驟

JobStepStatisticsBase

基本工作步驟統計資料

JobsGetOptionalParams

選擇性參數。

JobsListByTargetOptionalParams

選擇性參數。

JobsOperations

代表 Jobs 作業的介面。

PageSettings

byPage 方法的選項

PagedAsyncIterableIterator

允許非同步迭代迭代完成和按頁面進行的介面。

ProxyResource

Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置

ReconciliationPolicyProperties

定義 ReconciliationPolicy

RemoveRevisionParameter

安裝解決方案參數

RemoveVersionResponse

移除版本回應

ResolvedConfiguration

已解決的組態

Resource

回應中針對所有 Azure Resource Manager 資源傳回的常見欄位

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

代表結構描述作業的介面。

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

代表 Targets 作業的介面。

TargetsPublishSolutionVersionOptionalParams

選擇性參數。

TargetsRemoveRevisionOptionalParams

選擇性參數。

TargetsResolveConfigurationOptionalParams

選擇性參數。

TargetsReviewSolutionVersionOptionalParams

選擇性參數。

TargetsUninstallSolutionOptionalParams

選擇性參數。

TargetsUpdateExternalValidationStatusOptionalParams

選擇性參數。

TargetsUpdateOptionalParams

選擇性參數。

TaskOption

工作選項屬性

TaskSpec

任務規格

TrackedResource

Azure Resource Manager 的資源模型定義已追蹤最上層資源,其具有「標記」和「位置」

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 Edge 區域位置類型
CustomLocation:Azure 自訂位置類型

JobParameterBaseUnion

JobParameterBaseUnion 的別名

JobStatus

工作或工作步驟的狀態。
KnownJobStatus 可以與 JobStatus 互換使用,此列舉包含服務支援的已知值。

服務支援的已知值

啟動:工作或步驟未啟動。
進行中:工作或步驟正在進行中。
成功:工作或步驟成功。
失敗:工作或步驟失敗。

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>