How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure WorkloadInstance API

Workload instance controller.

Microsoft Azure WorkloadInstance API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WorkloadInstance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 7 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

7 operations 5 paths 11 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

WorkloadInstance 7

Workload instance controller.

GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}
Microsoft Azure Gets The Workload Instance
microsoftAzureWorkloadinstanceGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}
Microsoft Azure Puts The Workload Instance
microsoftAzureWorkloadinstanceCreate 5 params body → 201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}
Microsoft Azure Deletes The Workload Instance
microsoftAzureWorkloadinstanceDelete 5 params → 202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances
Microsoft Azure Lists The Workload Instances
microsoftAzureWorkloadinstanceList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/operations/{operationId}
Microsoft Azure Gets The Workload Instance Operation Status
microsoftAzureWorkloadinstanceoperationstatusGet 6 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/completeMigration
Microsoft Azure Performs Complete Migrate
microsoftAzureWorkloadinstanceMigratecomplete 5 params → 202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/disableReplication
Microsoft Azure Performs Disable Replicate
microsoftAzureWorkloadinstanceStopreplicate 5 params → 202default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are WorkloadInstanceModelProperties (15 properties), HealthErrorModel (15 properties), InnerHealthErrorModel (12 properties), WorkloadJobProperties (7 properties). Each schema is shown below with its type and property counts.

WorkloadInstanceModelProperties
object
Workload instance model properties.
15 properties
WorkloadJobProperties
object
Workload job properties.
7 properties
WorkloadInstanceModel
object
Workload instance model.
6 properties
WorkloadInstanceModelCustomProperties
object
Workload instance model custom properties.
3 properties 1 required
ArmError
object
ARM error.
1 property
HealthErrorModel
object
Health error model.
15 properties
OperationStatus
object
Defines the operation status.
5 properties
ArmErrorInfo
object
Arm error information.
2 properties
SystemDataModel
object
System data required to be defined for Azure resources.
6 properties
InnerHealthErrorModel
object
Inner health error model.
12 properties
WorkloadInstanceModelCollection
object
Workload instance model collection.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-workloadinstance-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure WorkloadInstance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.