@azure/arm-workloadorchestration package

Classes

Interfaces

AvailableSolutionTemplateVersion	Available Solution template Version along with latest revision
BulkDeploySolutionParameter	Bulk deploy solution parameter
BulkDeployTargetDetails	Bulk deploy target details
BulkPublishSolutionParameter	Bulk publish solution parameter
BulkPublishTargetDetails	Bulk publish target details
Capability	Capability, to match in Solution Templates & Targets
ComponentStatus	Component Status
ConfigTemplate	Config Template Resource. Contains configuration expressions using the predefined expression language.
ConfigTemplateProperties	Config Template Properties
ConfigTemplateUpdate	The type used for update operations of the ConfigTemplate.
ConfigTemplateUpdateProperties	The updatable properties of the ConfigTemplate.
ConfigTemplateVersion	Config Template Version Resource
ConfigTemplateVersionProperties	Config Template Version Properties
ConfigTemplateVersionWithUpdateType	Config Template Version With Update Type
ConfigTemplateVersionsGetOptionalParams	Optional parameters.
ConfigTemplateVersionsListByConfigTemplateOptionalParams	Optional parameters.
ConfigTemplateVersionsOperations	Interface representing a ConfigTemplateVersions operations.
ConfigTemplatesCreateOrUpdateOptionalParams	Optional parameters.
ConfigTemplatesCreateVersionOptionalParams	Optional parameters.
ConfigTemplatesDeleteOptionalParams	Optional parameters.
ConfigTemplatesGetOptionalParams	Optional parameters.
ConfigTemplatesListByResourceGroupOptionalParams	Optional parameters.
ConfigTemplatesListBySubscriptionOptionalParams	Optional parameters.
ConfigTemplatesOperations	Interface representing a ConfigTemplates operations.
ConfigTemplatesRemoveVersionOptionalParams	Optional parameters.
ConfigTemplatesUpdateOptionalParams	Optional parameters.
Context	Context Resource
ContextProperties	Context Properties
ContextUpdate	The type used for update operations of the Context.
ContextUpdateProperties	The updatable properties of the Context.
ContextsCreateOrUpdateOptionalParams	Optional parameters.
ContextsDeleteOptionalParams	Optional parameters.
ContextsGetOptionalParams	Optional parameters.
ContextsListByResourceGroupOptionalParams	Optional parameters.
ContextsListBySubscriptionOptionalParams	Optional parameters.
ContextsOperations	Interface representing a Contexts operations.
ContextsUpdateOptionalParams	Optional parameters.
DeployJobParameter	Parameters for a deployment job.
DeployJobStepStatistics	Deploy statistics for a job step, including total, success, and failed counts.
DeploymentStatus	Deployment Status
Diagnostic	A Diagnostic resource.
DiagnosticProperties	The properties of a Diagnostic resource.
DiagnosticUpdate	The type used for update operations of the Diagnostic.
DiagnosticUpdateProperties	The updatable properties of the Diagnostic.
DiagnosticsCreateOrUpdateOptionalParams	Optional parameters.
DiagnosticsDeleteOptionalParams	Optional parameters.
DiagnosticsGetOptionalParams	Optional parameters.
DiagnosticsListByResourceGroupOptionalParams	Optional parameters.
DiagnosticsListBySubscriptionOptionalParams	Optional parameters.
DiagnosticsOperations	Interface representing a Diagnostics operations.
DiagnosticsUpdateOptionalParams	Optional parameters.
DynamicSchema	DynamicSchema Resource
DynamicSchemaProperties	DynamicSchema Properties
DynamicSchemaVersion	Dynamic Schema Version Resource
DynamicSchemaVersionsCreateOrUpdateOptionalParams	Optional parameters.
DynamicSchemaVersionsDeleteOptionalParams	Optional parameters.
DynamicSchemaVersionsGetOptionalParams	Optional parameters.
DynamicSchemaVersionsListByDynamicSchemaOptionalParams	Optional parameters.
DynamicSchemaVersionsOperations	Interface representing a DynamicSchemaVersions operations.
DynamicSchemaVersionsUpdateOptionalParams	Optional parameters.
DynamicSchemasCreateOrUpdateOptionalParams	Optional parameters.
DynamicSchemasDeleteOptionalParams	Optional parameters.
DynamicSchemasGetOptionalParams	Optional parameters.
DynamicSchemasListBySchemaOptionalParams	Optional parameters.
DynamicSchemasOperations	Interface representing a DynamicSchemas operations.
DynamicSchemasUpdateOptionalParams	Optional parameters.
ErrorAction	Error Action Properties
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
Execution	Execution Resource
ExecutionProperties	Execution Properties
ExecutionStatus	Execution Status
ExecutionsCreateOrUpdateOptionalParams	Optional parameters.
ExecutionsDeleteOptionalParams	Optional parameters.
ExecutionsGetOptionalParams	Optional parameters.
ExecutionsListByWorkflowVersionOptionalParams	Optional parameters.
ExecutionsOperations	Interface representing a Executions operations.
ExecutionsUpdateOptionalParams	Optional parameters.
ExtendedLocation	The complex type of the extended location.
ExtensionResource	The base extension resource.
Hierarchy	Hierarchy, to tag Sites / Hierarchy Provider nodes with what they represent
InstallSolutionParameter	Install Solution Parameter
Instance	Instance Resource. Represents a deployment object.
InstanceHistoriesGetOptionalParams	Optional parameters.
InstanceHistoriesListByInstanceOptionalParams	Optional parameters.
InstanceHistoriesOperations	Interface representing a InstanceHistories operations.
InstanceHistory	InstanceHistory Resource
InstanceHistoryProperties	Instance History Properties
InstanceProperties	Instance Properties
InstancesCreateOrUpdateOptionalParams	Optional parameters.
InstancesDeleteOptionalParams	Optional parameters.
InstancesGetOptionalParams	Optional parameters.
InstancesListBySolutionOptionalParams	Optional parameters.
InstancesOperations	Interface representing a Instances operations.
InstancesUpdateOptionalParams	Optional parameters.
Job	Job extension resource for tracking job execution and substatuses.
JobParameterBase	Base Job Parameter
JobProperties	Properties of a Job resource, including type, status, parameters, steps, and error details.
JobStep	Job Step
JobStepStatisticsBase	Base Job Step Statistics
JobsGetOptionalParams	Optional parameters.
JobsListByTargetOptionalParams	Optional parameters.
JobsOperations	Interface representing a Jobs 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
ReconciliationPolicyProperties	Defines a ReconciliationPolicy
RemoveRevisionParameter	Install Solution Parameter
RemoveVersionResponse	Remove Version response
ResolvedConfiguration	Resolved Configuration
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
Schema	Schema Resource
SchemaProperties	Schema Properties
SchemaReference	Schema Reference Resource
SchemaReferenceProperties	Schema Reference Properties
SchemaReferencesGetOptionalParams	Optional parameters.
SchemaReferencesListByResourceGroupOptionalParams	Optional parameters.
SchemaReferencesOperations	Interface representing a SchemaReferences operations.
SchemaUpdate	The type used for update operations of the Schema.
SchemaUpdateProperties	The updatable properties of the Schema.
SchemaVersion	Schema Version Resource
SchemaVersionProperties	Schema Version Properties
SchemaVersionWithUpdateType	Schema Version With Update Type
SchemaVersionsCreateOrUpdateOptionalParams	Optional parameters.
SchemaVersionsDeleteOptionalParams	Optional parameters.
SchemaVersionsGetOptionalParams	Optional parameters.
SchemaVersionsListBySchemaOptionalParams	Optional parameters.
SchemaVersionsOperations	Interface representing a SchemaVersions operations.
SchemaVersionsUpdateOptionalParams	Optional parameters.
SchemasCreateOrUpdateOptionalParams	Optional parameters.
SchemasCreateVersionOptionalParams	Optional parameters.
SchemasDeleteOptionalParams	Optional parameters.
SchemasGetOptionalParams	Optional parameters.
SchemasListByResourceGroupOptionalParams	Optional parameters.
SchemasListBySubscriptionOptionalParams	Optional parameters.
SchemasOperations	Interface representing a Schemas operations.
SchemasRemoveVersionOptionalParams	Optional parameters.
SchemasUpdateOptionalParams	Optional parameters.
SiteReference	Site Reference Resource
SiteReferenceProperties	Site Reference Properties
SiteReferencesCreateOrUpdateOptionalParams	Optional parameters.
SiteReferencesDeleteOptionalParams	Optional parameters.
SiteReferencesGetOptionalParams	Optional parameters.
SiteReferencesListByContextOptionalParams	Optional parameters.
SiteReferencesOperations	Interface representing a SiteReferences operations.
SiteReferencesUpdateOptionalParams	Optional parameters.
Solution	Solution Resource attached to a Target
SolutionDependency	Solution Dependency Context
SolutionDependencyParameter	Solution Dependency Context
SolutionProperties	Solution Properties
SolutionTemplate	Solution Template Resource. Contains capabilities and operations for creating versions.
SolutionTemplateParameter	Solution Template Parameter
SolutionTemplateProperties	Solution Template Properties
SolutionTemplateUpdate	The type used for update operations of the SolutionTemplate.
SolutionTemplateUpdateProperties	The updatable properties of the SolutionTemplate.
SolutionTemplateVersion	Solution Template Version Resource. Contains configurations that use expressions which can be resolved hierarchically along with edge specifications.
SolutionTemplateVersionProperties	Solution Template Version Properties
SolutionTemplateVersionWithUpdateType	Solution Template Version With Update Type
SolutionTemplateVersionsBulkDeploySolutionOptionalParams	Optional parameters.
SolutionTemplateVersionsBulkPublishSolutionOptionalParams	Optional parameters.
SolutionTemplateVersionsGetOptionalParams	Optional parameters.
SolutionTemplateVersionsListBySolutionTemplateOptionalParams	Optional parameters.
SolutionTemplateVersionsOperations	Interface representing a SolutionTemplateVersions operations.
SolutionTemplatesCreateOrUpdateOptionalParams	Optional parameters.
SolutionTemplatesCreateVersionOptionalParams	Optional parameters.
SolutionTemplatesDeleteOptionalParams	Optional parameters.
SolutionTemplatesGetOptionalParams	Optional parameters.
SolutionTemplatesListByResourceGroupOptionalParams	Optional parameters.
SolutionTemplatesListBySubscriptionOptionalParams	Optional parameters.
SolutionTemplatesOperations	Interface representing a SolutionTemplates operations.
SolutionTemplatesRemoveVersionOptionalParams	Optional parameters.
SolutionTemplatesUpdateOptionalParams	Optional parameters.
SolutionUpdate	The type used for update operations of the Solution.
SolutionUpdateProperties	The updatable properties of the Solution.
SolutionVersion	Solution Version Resource. It has the resolved configuration along with edge specification.
SolutionVersionParameter	Solution Version Parameter
SolutionVersionProperties	Solution Version Properties
SolutionVersionSnapshot	Solution Version Snapshot
SolutionVersionsCreateOrUpdateOptionalParams	Optional parameters.
SolutionVersionsDeleteOptionalParams	Optional parameters.
SolutionVersionsGetOptionalParams	Optional parameters.
SolutionVersionsListBySolutionOptionalParams	Optional parameters.
SolutionVersionsOperations	Interface representing a SolutionVersions operations.
SolutionVersionsUpdateOptionalParams	Optional parameters.
SolutionsCreateOrUpdateOptionalParams	Optional parameters.
SolutionsDeleteOptionalParams	Optional parameters.
SolutionsGetOptionalParams	Optional parameters.
SolutionsListByTargetOptionalParams	Optional parameters.
SolutionsOperations	Interface representing a Solutions operations.
SolutionsUpdateOptionalParams	Optional parameters.
StageSpec	Stage Properties
StageStatus	Result of Stage execution
SystemData	Metadata pertaining to creation and last modification of the resource.
Target	Target Resource. Represents a resource to be deployed on the edge.
TargetProperties	Target Properties
TargetSnapshot	Target Snapshot
TargetStatus	Target Status
TargetUpdate	The type used for update operations of the Target.
TargetUpdateProperties	The updatable properties of the Target.
TargetsCreateOrUpdateOptionalParams	Optional parameters.
TargetsDeleteOptionalParams	Optional parameters.
TargetsGetOptionalParams	Optional parameters.
TargetsInstallSolutionOptionalParams	Optional parameters.
TargetsListByResourceGroupOptionalParams	Optional parameters.
TargetsListBySubscriptionOptionalParams	Optional parameters.
TargetsOperations	Interface representing a Targets operations.
TargetsPublishSolutionVersionOptionalParams	Optional parameters.
TargetsRemoveRevisionOptionalParams	Optional parameters.
TargetsResolveConfigurationOptionalParams	Optional parameters.
TargetsReviewSolutionVersionOptionalParams	Optional parameters.
TargetsUninstallSolutionOptionalParams	Optional parameters.
TargetsUpdateExternalValidationStatusOptionalParams	Optional parameters.
TargetsUpdateOptionalParams	Optional parameters.
TaskOption	Task Option Properties
TaskSpec	Task Spec
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UninstallSolutionParameter	Uninstall Solution Parameter
UpdateExternalValidationStatusParameter	Update External Validation Status Parameter
VersionParameter	Version Parameter
Workflow	Workflow Resource
WorkflowProperties	Workflow Properties
WorkflowVersion	Workflow Version Resource
WorkflowVersionProperties	Workflow Version Properties
WorkflowVersionsCreateOrUpdateOptionalParams	Optional parameters.
WorkflowVersionsDeleteOptionalParams	Optional parameters.
WorkflowVersionsGetOptionalParams	Optional parameters.
WorkflowVersionsListByWorkflowOptionalParams	Optional parameters.
WorkflowVersionsOperations	Interface representing a WorkflowVersions operations.
WorkflowVersionsUpdateOptionalParams	Optional parameters.
WorkflowsCreateOrUpdateOptionalParams	Optional parameters.
WorkflowsDeleteOptionalParams	Optional parameters.
WorkflowsGetOptionalParams	Optional parameters.
WorkflowsListByContextOptionalParams	Optional parameters.
WorkflowsOperations	Interface representing a Workflows operations.
WorkflowsUpdateOptionalParams	Optional parameters.
WorkloadOrchestrationManagementClientOptionalParams	Optional parameters for the client.

Type Aliases

ActiveState	Instance State KnownActiveState can be used interchangeably with ActiveState, this enum contains the known values that the service supports. Known values supported by the service active: Instance is active inactive: Instance is inactive
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ConfigurationModel	Available configuration models KnownConfigurationModel can be used interchangeably with ConfigurationModel, this enum contains the known values that the service supports. Known values supported by the service Application: Configuration model Application Common: Configuration model Common
ConfigurationType	Available configuration types KnownConfigurationType can be used interchangeably with ConfigurationType, this enum contains the known values that the service supports. Known values supported by the service Shared: Configuration type Shared Hierarchy: Configuration type Hierarchy
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. <xref: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.
ErrorActionMode	Error Action Mode KnownErrorActionMode can be used interchangeably with ErrorActionMode, this enum contains the known values that the service supports. Known values supported by the service stopOnAnyFailure: Stop on any failure stopOnNFailures: Stop after N cumulative failures silentlyContinue: Continue silently despite errors
ExtendedLocationType	The supported ExtendedLocation types. KnownExtendedLocationType can be used interchangeably with ExtendedLocationType, this enum contains the known values that the service supports. Known values supported by the service EdgeZone: Azure Edge Zones location type CustomLocation: Azure Custom Locations type
JobParameterBaseUnion	Alias for JobParameterBaseUnion
JobStatus	Status of a job or job step. KnownJobStatus can be used interchangeably with JobStatus, this enum contains the known values that the service supports. Known values supported by the service NotStarted: The job or step is not started. InProgress: The job or step is in progress. Succeeded: The job or step succeeded. Failed: The job or step failed.
JobStepStatisticsBaseUnion	Alias for JobStepStatisticsBaseUnion
JobType	JobType for the job. Supports extensibility via string values. KnownJobType can be used interchangeably with JobType, this enum contains the known values that the service supports. Known values supported by the service deploy: A deployment job. staging: A staging job. externalValidation: A validation job.
OrchestratorType	Available Orchestrator types KnownOrchestratorType can be used interchangeably with OrchestratorType, this enum contains the known values that the service supports. Known values supported by the service TO: Default type
ProvisioningState	Provisioning state of resource KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Initialized: Resource Provisioning is initialized InProgress: Resource Provisioning is in progress Deleting: Resource Provisioning is deleting
ReconciliationState	Defines a state of the reconciliation policy. KnownReconciliationState can be used interchangeably with ReconciliationState, this enum contains the known values that the service supports. Known values supported by the service inactive: Reconciliation is inactive active: Reconciliation is active
ResourceState	Resource Type State KnownResourceState can be used interchangeably with ResourceState, this enum contains the known values that the service supports. Known values supported by the service active: Resource is active inactive: Resource is inactive
State	Solution Instance State KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service InReview: Solution Instance is in review UpgradeInReview: Solution Instance upgrade is in review ReadyToDeploy: Solution Instance is ready to deploy ReadyToUpgrade: Solution Instance is ready to upgrade Deploying: Solution Instance is deploying Deployed: Solution Instance is deployed Failed: Solution Instance failed to deploy Undeployed: Solution Instance is undeployed PendingExternalValidation: Solution Instance is pending external validation ExternalValidationFailed: Solution Instance failed external validation Staging: Solution Instance is staging the images
UpdateType	Denotes which part of the version number will be updated KnownUpdateType can be used interchangeably with UpdateType, this enum contains the known values that the service supports. Known values supported by the service Major: Major version Minor: Minor version Patch: Patch version
ValidationStatus	Solution Instance Validation Status KnownValidationStatus can be used interchangeably with ValidationStatus, this enum contains the known values that the service supports. Known values supported by the service Valid: Solution Instance is valid Invalid: Solution Instance is invalid

Enums

AzureClouds	An enum to describe Azure Cloud.
KnownActiveState	Instance State
KnownConfigurationModel	Available configuration models
KnownConfigurationType	Available configuration types
KnownCreatedByType	The kind of entity that created the resource.
KnownErrorActionMode	Error Action Mode
KnownExtendedLocationType	The supported ExtendedLocation types.
KnownJobStatus	Status of a job or job step.
KnownJobType	JobType for the job. Supports extensibility via string values.
KnownOrchestratorType	Available Orchestrator types
KnownProvisioningState	Provisioning state of resource
KnownReconciliationState	Defines a state of the reconciliation policy.
KnownResourceState	Resource Type State
KnownState	Solution Instance State
KnownUpdateType	Denotes which part of the version number will be updated
KnownValidationStatus	Solution Instance Validation Status
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(WorkloadOrchestrationManagementClient, 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 Details

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>

Parameters

client: WorkloadOrchestrationManagementClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Feedback

Was this page helpful?

Share via

@azure/arm-workloadorchestration package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

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

Parameters

Returns

Feedback