@azure/arm-computeworkloadmanager package

Classes

WorkloadManagerClient

Interfaces

CapabilitiesCreateOrUpdateOptionalParams	Optional parameters.
CapabilitiesDeleteOptionalParams	Optional parameters.
CapabilitiesGetOptionalParams	Optional parameters.
CapabilitiesListByWorkloadSpaceOptionalParams	Optional parameters.
CapabilitiesOperations	Interface representing a Capabilities operations.
CapabilitiesUpdateOptionalParams	Optional parameters.
Capability	A capability enabled for a workload space.
CapabilityProperties	Properties of a capability enabled for a workload space.
CapabilityUpdate	Mutable properties of a capability.
CapabilityUpdateProperties	The updatable properties of the Capability.
CapacityProfile	Capacity policy for the runtime composition.
CapacityProfileUpdate	Capacity policy values that may be updated for the runtime composition.
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.
ExecutionIdentity	Configuration for an identity used by an execution runtime.
ExecutionIdentityUpdate	Execution identity configuration that may be updated.
ManagedRuntimeBindingProperties	Properties of a runtime provisioned and owned by Workload Manager.
ManagedRuntimeProfile	Customer-selected configuration for a service-managed runtime.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ReferencedExecutionIdentity	A customer-provided identity used by an execution runtime.
ReferencedRuntimeBindingProperties	Properties of a customer-owned runtime attached to a workload space.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
RuntimeBinding	A runtime participant in a workload space.
RuntimeBindingProperties	Common properties of managed and referenced runtime bindings.
RuntimeBindingUpdate	Mutable properties of a runtime binding.
RuntimeBindingUpdateProperties	The updatable properties of the RuntimeBinding.
RuntimeBindingsCreateOrUpdateOptionalParams	Optional parameters.
RuntimeBindingsDeleteOptionalParams	Optional parameters.
RuntimeBindingsGetOptionalParams	Optional parameters.
RuntimeBindingsListByWorkloadSpaceOptionalParams	Optional parameters.
RuntimeBindingsOperations	Interface representing a RuntimeBindings operations.
RuntimeBindingsUpdateOptionalParams	Optional parameters.
RuntimeIdentityProfile	Identity configuration for a managed runtime.
RuntimeIdentityProfileUpdate	Identity configuration that may be updated for a managed runtime.
RuntimeLink	A relationship between an orchestrator runtime and an optional execution runtime.
RuntimeLinkIntegrationProfile	Identity configuration used to integrate runtime bindings.
RuntimeLinkProperties	Properties of a relationship between runtime bindings.
RuntimeLinkUpdate	Mutable properties of a runtime link.
RuntimeLinkUpdateProperties	The updatable properties of the RuntimeLink.
RuntimeLinksCreateOrUpdateOptionalParams	Optional parameters.
RuntimeLinksDeleteOptionalParams	Optional parameters.
RuntimeLinksGetOptionalParams	Optional parameters.
RuntimeLinksListByWorkloadSpaceOptionalParams	Optional parameters.
RuntimeLinksOperations	Interface representing a RuntimeLinks operations.
RuntimeLinksUpdateOptionalParams	Optional parameters.
RuntimeNetworkProfile	Network configuration for a managed runtime.
ServiceManagedExecutionIdentity	An identity created and owned by Workload Manager.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
WorkloadManagerClientOptionalParams	Optional parameters for the client.
WorkloadSpace	A regional governance and lifecycle boundary for composed runtimes.
WorkloadSpaceProperties	Properties of a workload space.
WorkloadSpaceUpdate	Mutable properties of a workload space.
WorkloadSpacesCreateOrUpdateOptionalParams	Optional parameters.
WorkloadSpacesDeleteOptionalParams	Optional parameters.
WorkloadSpacesGetOptionalParams	Optional parameters.
WorkloadSpacesListByResourceGroupOptionalParams	Optional parameters.
WorkloadSpacesListBySubscriptionOptionalParams	Optional parameters.
WorkloadSpacesOperations	Interface representing a WorkloadSpaces operations.
WorkloadSpacesUpdateOptionalParams	Optional parameters.

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
CapabilityKind	The capability enabled for a workload space. KnownCapabilityKind can be used interchangeably with CapabilityKind, this enum contains the known values that the service supports. Known values supported by the service AgentSandbox: Enables isolated agent sandbox execution.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. 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.
EgressMode	The egress ownership mode for a managed runtime. KnownEgressMode can be used interchangeably with EgressMode, this enum contains the known values that the service supports. Known values supported by the service CustomerManaged: The customer supplies and manages the egress configuration.
ExecutionIdentityProvisioningMode	The provisioning mode for an execution identity. KnownExecutionIdentityProvisioningMode can be used interchangeably with ExecutionIdentityProvisioningMode, this enum contains the known values that the service supports. Known values supported by the service Referenced: Uses a customer-provided identity. ServiceManaged: Workload Manager creates and owns the identity.
ExecutionIdentityScope	The scope at which an execution identity is shared. KnownExecutionIdentityScope can be used interchangeably with ExecutionIdentityScope, this enum contains the known values that the service supports. Known values supported by the service SandboxGroup: The identity is shared by sandboxes in the execution group.
ExecutionIdentityUnion	Alias for ExecutionIdentityUnion
ProvisioningState	The provisioning state of a Workload Manager 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. Accepted: The request has been accepted for processing. Provisioning: The resource is being provisioned. Updating: The resource is being updated. Deleting: The resource is being deleted.
RuntimeBindingKind	The runtime technology represented by a binding. KnownRuntimeBindingKind can be used interchangeably with RuntimeBindingKind, this enum contains the known values that the service supports. Known values supported by the service Kubernetes: A Kubernetes orchestration runtime. ServerlessContainers: A serverless container execution runtime.
RuntimeBindingPropertiesUnion	Alias for RuntimeBindingPropertiesUnion
RuntimeBindingProvisioningMode	The ownership mode for a runtime binding. KnownRuntimeBindingProvisioningMode can be used interchangeably with RuntimeBindingProvisioningMode, this enum contains the known values that the service supports. Known values supported by the service Managed: Workload Manager creates and owns the provider resource. Referenced: Workload Manager attaches an existing customer-owned resource.
VersionPolicy	The version selection policy for a capability. KnownVersionPolicy can be used interchangeably with VersionPolicy, this enum contains the known values that the service supports. Known values supported by the service ServiceManaged: Workload Manager selects and upgrades the capability version.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCapabilityKind	The capability enabled for a workload space.
KnownCreatedByType	The kind of entity that created the resource.
KnownEgressMode	The egress ownership mode for a managed runtime.
KnownExecutionIdentityProvisioningMode	The provisioning mode for an execution identity.
KnownExecutionIdentityScope	The scope at which an execution identity is shared.
KnownProvisioningState	The provisioning state of a Workload Manager resource.
KnownRuntimeBindingKind	The runtime technology represented by a binding.
KnownRuntimeBindingProvisioningMode	The ownership mode for a runtime binding.
KnownVersionPolicy	The version selection policy for a capability.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(WorkloadManagerClient, 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.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(WorkloadManagerClient, 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 restorePoller<TResponse, TResult>(client: WorkloadManagerClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

WorkloadManagerClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor