swagger: '2.0' info: title: Microsoft Azure Azure Migrate Engine APIs description: A first party Azure service for modernizing workloads. version: 2022-05-01-preview paths: /providers/Microsoft.Migrate/operations: get: tags: - Operations description: Lists all the available API operations under this PR operationId: microsoftAzureOperationsList produces: - application/json parameters: - $ref: >- ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: >- ../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult default: description: Resource provider error response about the failure. schema: $ref: >- ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Operations_List_MaximumSet_Gen: $ref: ./examples/Operations_List_MaximumSet_Gen.json Operations_List_MinimumSet_Gen: $ref: ./examples/Operations_List_MinimumSet_Gen.json summary: Microsoft Azure Get Providers Microsoft Migrate Operations ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/deployedResources/{deployedResourceName} : get: tags: - DeployedResource summary: 'Microsoft Azure Gets The Deployed Resource' description: Gets the details of the deployed resource. operationId: microsoftAzureDeployedresourceGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: deployedResourceName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/DeployedResourceModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: DeployedResource_Get_MaximumSet_Gen: $ref: ./examples/DeployedResource_Get_MaximumSet_Gen.json DeployedResource_Get_MinimumSet_Gen: $ref: ./examples/DeployedResource_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/deployedResources : get: tags: - DeployedResource summary: 'Microsoft Azure Lists The Deployed Resources' description: Gets the list of deployed resources in the given modernizeProject. operationId: microsoftAzureDeployedresourceList produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/DeployedResourceModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: DeployedResource_List_MaximumSet_Gen: $ref: ./examples/DeployedResource_List_MaximumSet_Gen.json DeployedResource_List_MinimumSet_Gen: $ref: ./examples/DeployedResource_List_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents/{agentName} : get: tags: - MigrateAgent summary: 'Microsoft Azure Gets The Migrateagent' description: Gets the details of the modernizeProject agent. operationId: microsoftAzureMigrateagentGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: agentName pattern: ^[a-z][a-z0-9]*$ description: MigrateAgent name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/MigrateAgentModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: MigrateAgent_Get_MaximumSet_Gen: $ref: ./examples/MigrateAgent_Get_MaximumSet_Gen.json MigrateAgent_Get_MinimumSet_Gen: $ref: ./examples/MigrateAgent_Get_MinimumSet_Gen.json put: tags: - MigrateAgent summary: 'Microsoft Azure Puts The Migrateagent' description: Creates the modernizeProject agent. operationId: microsoftAzureMigrateagentCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: agentName pattern: ^[a-z][a-z0-9]*$ description: MigrateAgent name. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: MigrateAgent model. schema: $ref: '#/definitions/MigrateAgentModel' responses: '201': description: Created schema: $ref: '#/definitions/MigrateAgentModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: MigrateAgent_Create_MaximumSet_Gen: $ref: ./examples/MigrateAgent_Create_MaximumSet_Gen.json MigrateAgent_Create_MinimumSet_Gen: $ref: ./examples/MigrateAgent_Create_MinimumSet_Gen.json delete: tags: - MigrateAgent summary: 'Microsoft Azure Deletes The Migrateagent' description: Deletes the modernizeProject agent. operationId: microsoftAzureMigrateagentDelete produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject Name. required: true type: string - in: path name: agentName pattern: ^[a-z][a-z0-9]*$ description: MigrateAgent Name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string '204': description: No Content default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: MigrateAgent_Delete_MaximumSet_Gen: $ref: ./examples/MigrateAgent_Delete_MaximumSet_Gen.json MigrateAgent_Delete_MinimumSet_Gen: $ref: ./examples/MigrateAgent_Delete_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents : get: tags: - MigrateAgent summary: 'Microsoft Azure Lists The Migrateagents' description: Gets the list of modernizeProject agents in the given modernizeProject. operationId: microsoftAzureMigrateagentList produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/MigrateAgentModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: MigrateAgent_List_MaximumSet_Gen: $ref: ./examples/MigrateAgent_List_MaximumSet_Gen.json MigrateAgent_List_MinimumSet_Gen: $ref: ./examples/MigrateAgent_List_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents/{agentName}/refresh : post: tags: - MigrateAgent summary: 'Microsoft Azure Refreshes The Migrateagent' description: Refreshes the modernizeProject agent. operationId: microsoftAzureMigrateagentRefresh produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: agentName pattern: ^[a-z][a-z0-9]*$ description: MigrateAgent name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: MigrateAgent_Refresh_MaximumSet_Gen: $ref: ./examples/MigrateAgent_Refresh_MaximumSet_Gen.json MigrateAgent_Refresh_MinimumSet_Gen: $ref: ./examples/MigrateAgent_Refresh_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents/{agentName}/operations/{operationId} : get: tags: - MigrateAgent summary: 'Microsoft Azure Gets The Migrateagent Operation Status' description: >- Tracks the results of an asynchronous operation on the modernizeProject agent. operationId: microsoftAzureMigrateagentoperationstatusGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: agentName pattern: ^[a-z][a-z0-9]*$ description: MigrateAgent name. required: true type: string - in: path name: operationId description: Operation Id. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/OperationStatus' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: MigrateAgentOperationStatus_Get_MaximumSet_Gen: $ref: ./examples/MigrateAgentOperationStatus_Get_MaximumSet_Gen.json MigrateAgentOperationStatus_Get_MinimumSet_Gen: $ref: ./examples/MigrateAgentOperationStatus_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName} : get: tags: - ModernizeProject summary: 'Microsoft Azure Gets The Modernize Project' description: Gets the details of the modernize project. operationId: microsoftAzureModernizeprojectGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: Modernize project name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/ModernizeProjectModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: ModernizeProject_Get_MaximumSet_Gen: $ref: ./examples/ModernizeProject_Get_MaximumSet_Gen.json ModernizeProject_Get_MinimumSet_Gen: $ref: ./examples/ModernizeProject_Get_MinimumSet_Gen.json put: tags: - ModernizeProject summary: 'Microsoft Azure Puts The Modernizeproject' description: Creates the modernizeProject. operationId: microsoftAzureModernizeprojectCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject Name. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: ModernizeProject properties. schema: $ref: '#/definitions/ModernizeProjectModel' responses: '201': description: Created schema: $ref: '#/definitions/ModernizeProjectModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: ModernizeProject_Create_MaximumSet_Gen: $ref: ./examples/ModernizeProject_Create_MaximumSet_Gen.json ModernizeProject_Create_MinimumSet_Gen: $ref: ./examples/ModernizeProject_Create_MinimumSet_Gen.json patch: tags: - ModernizeProject summary: 'Microsoft Azure Updates The Modernizeproject' description: Performs update on the modernizeProject. operationId: microsoftAzureModernizeprojectUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject Name. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: ModernizeProject properties. schema: $ref: '#/definitions/UpdateModernizeProjectModel' responses: '202': description: Accepted schema: $ref: '#/definitions/ModernizeProjectModel' headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: ModernizeProject_Update_MaximumSet_Gen: $ref: ./examples/ModernizeProject_Update_MaximumSet_Gen.json ModernizeProject_Update_MinimumSet_Gen: $ref: ./examples/ModernizeProject_Update_MinimumSet_Gen.json delete: tags: - ModernizeProject summary: 'Microsoft Azure Deletes The Modernizeproject' description: Removes the modernizeProject. operationId: microsoftAzureModernizeprojectDelete produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject Name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string '204': description: No Content default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: ModernizeProject_Delete_MaximumSet_Gen: $ref: ./examples/ModernizeProject_Delete_MaximumSet_Gen.json ModernizeProject_Delete_MinimumSet_Gen: $ref: ./examples/ModernizeProject_Delete_MinimumSet_Gen.json /subscriptions/{subscriptionId}/providers/Microsoft.Migrate/modernizeProjects: get: tags: - ModernizeProject summary: 'Microsoft Azure Lists The Modernizeprojects' description: Gets the list of modernizeProjects in the given subscription. operationId: microsoftAzureModernizeprojectListbysubscription produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - in: query name: continuationToken description: Continuation token from the previous call. type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/ModernizeProjectModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: ModernizeProject_ListBySubscription_MaximumSet_Gen: $ref: ./examples/ModernizeProject_ListBySubscription_MaximumSet_Gen.json ModernizeProject_ListBySubscription_MinimumSet_Gen: $ref: ./examples/ModernizeProject_ListBySubscription_MinimumSet_Gen.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects: get: tags: - ModernizeProject summary: 'Microsoft Azure Lists The Modernizeprojects' description: >- Gets the list of modernizeProjects in the given subscription and resource group. operationId: microsoftAzureModernizeprojectList produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: query name: continuationToken description: Continuation token from the previous call. type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/ModernizeProjectModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: ModernizeProject_List_MaximumSet_Gen: $ref: ./examples/ModernizeProject_List_MaximumSet_Gen.json ModernizeProject_List_MinimumSet_Gen: $ref: ./examples/ModernizeProject_List_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/statistics : get: tags: - ModernizeProject summary: 'Microsoft Azure Gets The Modernizeproject Statistics' description: Gets the statistics for the modernizeProject. operationId: microsoftAzureModernizeprojectstatisticsGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/ModernizeProjectStatisticsModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: ModernizeProjectStatistics_Get_MaximumSet_Gen: $ref: ./examples/ModernizeProjectStatistics_Get_MaximumSet_Gen.json ModernizeProjectStatistics_Get_MinimumSet_Gen: $ref: ./examples/ModernizeProjectStatistics_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/operations/{operationId} : get: tags: - ModernizeProject summary: 'Microsoft Azure Gets The Modernizeproject Operation Status' description: Tracks the results of an asynchronous operation on the modernizeProject. operationId: microsoftAzureModernizeprojectoperationstatusGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: operationId description: Operation Id. required: true type: string - in: query name: OperationType description: The operation type. type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/OperationStatus' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: ModernizeProjectOperationStatus_Get_MaximumSet_Gen: $ref: ./examples/ModernizeProjectOperationStatus_Get_MaximumSet_Gen.json ModernizeProjectOperationStatus_Get_MinimumSet_Gen: $ref: ./examples/ModernizeProjectOperationStatus_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName} : get: tags: - Workflow summary: 'Microsoft Azure Gets The Workflow' description: Gets the details of the job. operationId: microsoftAzureWorkflowGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workflowName pattern: ^[a-z][a-z0-9]*$ description: Workflow name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkflowModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: Workflow_Get_MaximumSet_Gen: $ref: ./examples/Workflow_Get_MaximumSet_Gen.json Workflow_Get_MinimumSet_Gen: $ref: ./examples/Workflow_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs : get: tags: - Workflow summary: 'Microsoft Azure Lists The Workflows' description: Gets the list of jobs in the given modernizeProject. operationId: microsoftAzureWorkflowList produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: query name: $filter description: Filter string. type: string - in: query name: continuationToken description: Continuation token. type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkflowModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Workflow_List_MaximumSet_Gen: $ref: ./examples/Workflow_List_MaximumSet_Gen.json Workflow_List_MinimumSet_Gen: $ref: ./examples/Workflow_List_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName}/operations/{operationId} : get: tags: - Workflow summary: 'Microsoft Azure Gets The Workflow Operation Status' description: Tracks the results of an asynchronous operation on the job. operationId: microsoftAzureWorkflowoperationstatusGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workflowName pattern: ^[a-z][a-z0-9]*$ description: Workflow name. required: true type: string - in: path name: operationId description: Operation Id. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/OperationStatus' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkflowOperationStatus_Get_MaximumSet_Gen: $ref: ./examples/WorkflowOperationStatus_Get_MaximumSet_Gen.json WorkflowOperationStatus_Get_MinimumSet_Gen: $ref: ./examples/WorkflowOperationStatus_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName} : get: tags: - WorkloadDeployment summary: 'Microsoft Azure Gets The Workload Deployment' description: Gets the details of the workload deployment. operationId: microsoftAzureWorkloaddeploymentGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkloadDeploymentModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkloadDeployment_Get_MaximumSet_Gen: $ref: ./examples/WorkloadDeployment_Get_MaximumSet_Gen.json WorkloadDeployment_Get_MinimumSet_Gen: $ref: ./examples/WorkloadDeployment_Get_MinimumSet_Gen.json put: tags: - WorkloadDeployment summary: 'Microsoft Azure Puts The Workload Deployment' description: Creates the workload deployment. operationId: microsoftAzureWorkloaddeploymentCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: Workload deployment model. schema: $ref: '#/definitions/WorkloadDeploymentModel' responses: '201': description: Created schema: $ref: '#/definitions/WorkloadDeploymentModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkloadDeployment_Create_MaximumSet_Gen: $ref: ./examples/WorkloadDeployment_Create_MaximumSet_Gen.json WorkloadDeployment_Create_MinimumSet_Gen: $ref: ./examples/WorkloadDeployment_Create_MinimumSet_Gen.json delete: tags: - WorkloadDeployment summary: 'Microsoft Azure Deletes The Workload Deployment' description: Removes the workload deployment. operationId: microsoftAzureWorkloaddeploymentDelete produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - in: query name: forceDelete description: A flag indicating whether to do force delete or not. type: boolean - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string '204': description: No Content default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadDeployment_Delete_MaximumSet_Gen: $ref: ./examples/WorkloadDeployment_Delete_MaximumSet_Gen.json WorkloadDeployment_Delete_MinimumSet_Gen: $ref: ./examples/WorkloadDeployment_Delete_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments : get: tags: - WorkloadDeployment summary: 'Microsoft Azure Lists The Workload Deployments' description: Gets the list of workload deployments in the given modernizeProject. operationId: microsoftAzureWorkloaddeploymentList produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkloadDeploymentModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: WorkloadDeployment_List_MaximumSet_Gen: $ref: ./examples/WorkloadDeployment_List_MaximumSet_Gen.json WorkloadDeployment_List_MinimumSet_Gen: $ref: ./examples/WorkloadDeployment_List_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/getSecrets : post: tags: - WorkloadDeployment summary: 'Microsoft Azure Gets The Workload Deployment Secrets' description: Gets the secrets of the workload deployment. operationId: microsoftAzureWorkloaddeploymentGetsecretconfigurations produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkloadDeploymentModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkloadDeployment_GetSecretConfigurations_MaximumSet_Gen: $ref: >- ./examples/WorkloadDeployment_GetSecretConfigurations_MaximumSet_Gen.json WorkloadDeployment_GetSecretConfigurations_MinimumSet_Gen: $ref: >- ./examples/WorkloadDeployment_GetSecretConfigurations_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/buildContainerImage : post: tags: - WorkloadDeployment summary: 'Microsoft Azure Build Container Image' description: Performs the build container image action on the workload deployment. operationId: microsoftAzureWorkloaddeploymentBuildcontainerimage consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: Build container image model. schema: $ref: '#/definitions/BuildContainerImageModel' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadDeployment_BuildContainerImage_MaximumSet_Gen: $ref: >- ./examples/WorkloadDeployment_BuildContainerImage_MaximumSet_Gen.json WorkloadDeployment_BuildContainerImage_MinimumSet_Gen: $ref: >- ./examples/WorkloadDeployment_BuildContainerImage_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/testMigrate : post: tags: - WorkloadDeployment summary: 'Microsoft Azure Performs Test Migrate' description: Performs the test migrate on the workload deployment. operationId: microsoftAzureWorkloaddeploymentTestmigrate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: Test migrate model. schema: $ref: '#/definitions/TestMigrateModel' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadDeployment_TestMigrate_MaximumSet_Gen: $ref: ./examples/WorkloadDeployment_TestMigrate_MaximumSet_Gen.json WorkloadDeployment_TestMigrate_MinimumSet_Gen: $ref: ./examples/WorkloadDeployment_TestMigrate_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/testMigrateCleanup : post: tags: - WorkloadDeployment summary: 'Microsoft Azure Performs Test Migrate Cleanup' description: Performs the test migrate cleanup on the workload deployment. operationId: microsoftAzureWorkloaddeploymentTestmigratecleanup produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadDeployment_TestMigrateCleanup_MaximumSet_Gen: $ref: ./examples/WorkloadDeployment_TestMigrateCleanup_MaximumSet_Gen.json WorkloadDeployment_TestMigrateCleanup_MinimumSet_Gen: $ref: ./examples/WorkloadDeployment_TestMigrateCleanup_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/migrate : post: tags: - WorkloadDeployment summary: 'Microsoft Azure Performs Migrate' description: Performs migrate on the workload deployment. operationId: microsoftAzureWorkloaddeploymentMigrate produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Workload deployment name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadDeployment_Migrate_MaximumSet_Gen: $ref: ./examples/WorkloadDeployment_Migrate_MaximumSet_Gen.json WorkloadDeployment_Migrate_MinimumSet_Gen: $ref: ./examples/WorkloadDeployment_Migrate_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/operations/{operationId} : get: tags: - WorkloadDeployment summary: 'Microsoft Azure Gets The Workload Deployment Operation Status' description: >- Tracks the results of an asynchronous operation on the workload deployment. operationId: microsoftAzureWorkloaddeploymentoperationstatusGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadDeploymentName pattern: ^[a-z][a-z0-9]*$ description: Protected Item name. required: true type: string - in: path name: operationId description: Operation Id. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/OperationStatus' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkloadDeploymentOperationStatus_Get_MaximumSet_Gen: $ref: ./examples/WorkloadDeploymentOperationStatus_Get_MaximumSet_Gen.json WorkloadDeploymentOperationStatus_Get_MinimumSet_Gen: $ref: ./examples/WorkloadDeploymentOperationStatus_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName} : get: tags: - WorkloadInstance summary: 'Microsoft Azure Gets The Workload Instance' description: Gets the details of the workload instance. operationId: microsoftAzureWorkloadinstanceGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadInstanceName pattern: ^[a-z][a-z0-9]*$ description: Workload instance name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkloadInstanceModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkloadInstance_Get_MaximumSet_Gen: $ref: ./examples/WorkloadInstance_Get_MaximumSet_Gen.json WorkloadInstance_Get_MinimumSet_Gen: $ref: ./examples/WorkloadInstance_Get_MinimumSet_Gen.json put: tags: - WorkloadInstance summary: 'Microsoft Azure Puts The Workload Instance' description: Creates the workload instance in the given modernizeProject. operationId: microsoftAzureWorkloadinstanceCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadInstanceName pattern: ^[a-z][a-z0-9]*$ description: Workload instance name. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: Workload instance model. schema: $ref: '#/definitions/WorkloadInstanceModel' responses: '201': description: Created schema: $ref: '#/definitions/WorkloadInstanceModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkloadInstance_Create_MaximumSet_Gen: $ref: ./examples/WorkloadInstance_Create_MaximumSet_Gen.json WorkloadInstance_Create_MinimumSet_Gen: $ref: ./examples/WorkloadInstance_Create_MinimumSet_Gen.json delete: tags: - WorkloadInstance summary: 'Microsoft Azure Deletes The Workload Instance' description: Deletes the workload instance in the given modernizeProject. operationId: microsoftAzureWorkloadinstanceDelete produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject Name. required: true type: string - in: path name: workloadInstanceName pattern: ^[a-z][a-z0-9]*$ description: Workload instance name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string '204': description: No Content default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadInstance_Delete_MaximumSet_Gen: $ref: ./examples/WorkloadInstance_Delete_MaximumSet_Gen.json WorkloadInstance_Delete_MinimumSet_Gen: $ref: ./examples/WorkloadInstance_Delete_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances : get: tags: - WorkloadInstance summary: 'Microsoft Azure Lists The Workload Instances' description: Gets the list of workload instances in the given modernizeProject. operationId: microsoftAzureWorkloadinstanceList produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkloadInstanceModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: WorkloadInstance_List_MaximumSet_Gen: $ref: ./examples/WorkloadInstance_List_MaximumSet_Gen.json WorkloadInstance_List_MinimumSet_Gen: $ref: ./examples/WorkloadInstance_List_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/operations/{operationId} : get: tags: - WorkloadInstance summary: 'Microsoft Azure Gets The Workload Instance Operation Status' description: >- Tracks the results of an asynchronous operation on the workload instance. operationId: microsoftAzureWorkloadinstanceoperationstatusGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadInstanceName pattern: ^[a-z][a-z0-9]*$ description: Workload instance name. required: true type: string - in: path name: operationId description: Operation Id. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/OperationStatus' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkloadInstanceOperationStatus_Get_MaximumSet_Gen: $ref: ./examples/WorkloadInstanceOperationStatus_Get_MaximumSet_Gen.json WorkloadInstanceOperationStatus_Get_MinimumSet_Gen: $ref: ./examples/WorkloadInstanceOperationStatus_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/completeMigration : post: tags: - WorkloadInstance summary: 'Microsoft Azure Performs Complete Migrate' description: Performs the complete migrate on the workload instance. operationId: microsoftAzureWorkloadinstanceMigratecomplete produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadInstanceName pattern: ^[a-z][a-z0-9]*$ description: Workload instance name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadInstance_MigrateComplete_MaximumSet_Gen: $ref: ./examples/WorkloadInstance_MigrateComplete_MaximumSet_Gen.json WorkloadInstance_MigrateComplete_MinimumSet_Gen: $ref: ./examples/WorkloadInstance_MigrateComplete_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/disableReplication : post: tags: - WorkloadInstance summary: 'Microsoft Azure Performs Disable Replicate' description: Performs the disable replicate on the workload instance. operationId: microsoftAzureWorkloadinstanceStopreplicate produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workloadInstanceName pattern: ^[a-z][a-z0-9]*$ description: Workload instance name. required: true type: string - $ref: '#/parameters/api-version' responses: '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string Location: type: string default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: WorkloadInstance_StopReplicate_MaximumSet_Gen: $ref: ./examples/WorkloadInstance_StopReplicate_MaximumSet_Gen.json WorkloadInstance_StopReplicate_MinimumSet_Gen: $ref: ./examples/WorkloadInstance_StopReplicate_MinimumSet_Gen.json definitions: ACRProperties: description: Class for ACR Properties. type: object properties: registryName: description: Gets or sets the azure container registry name. type: string tenantId: description: Gets or sets the tenant id. type: string subscriptionId: description: Gets or sets the subscription id of the resource. type: string resourceGroup: description: Gets or sets the resource group of the resource. type: string AKSDeploymentProperties: description: Class for AKSDeployment Properties. type: object properties: aksClusterName: description: Gets or sets the AKS cluster name. type: string tenantId: description: Gets or sets the tenant id. type: string subscriptionId: description: Gets or sets the subscription id of the resource. type: string resourceGroup: description: Gets or sets the resource group of the resource. type: string AKSDeploymentSpecification: description: AKS Deployment Specification. type: object properties: kubernetesObjectsYaml: description: Gets or sets the Merged Deployment and service Yaml. type: string replicaCount: description: Gets or sets the replica count to be created in AKS. type: string loadBalancerType: description: Gets or sets the load balancer type. enum: - Private - Public type: string x-ms-enum: name: LoadBalancerType modelAsString: true ApacheTomcatAKSWorkloadDeployment: description: ApacheTomcat web application. type: object properties: clusterProperties: $ref: '#/definitions/AKSDeploymentProperties' deploymentSpec: $ref: '#/definitions/AKSDeploymentSpecification' deploymentHistory: description: Gets or sets the deployment history. type: array items: $ref: '#/definitions/DeployedResourcesProperties' readOnly: true deploymentNamePrefix: description: Gets or sets the deployment name prefix. type: string automationArtifactProperties: $ref: '#/definitions/AutomationArtifact' directories: description: Gets or sets application directories. type: array items: $ref: '#/definitions/WebApplicationDirectory' configurations: description: Gets or sets application configuration. type: array items: $ref: '#/definitions/WebApplicationConfiguration' containerImageProperties: $ref: '#/definitions/ContainerImageProperties' buildContainerImages: description: Gets or sets the build container images. type: array items: $ref: '#/definitions/ContainerImageProperties' bindings: description: Gets or sets the bindings for the application. type: array items: $ref: '#/definitions/Binding' requests: $ref: '#/definitions/ResourceRequirements' limits: $ref: '#/definitions/ResourceRequirements' targetPlatformIdentity: description: Gets or sets the target platform managed identity. type: string monitoringProperties: $ref: '#/definitions/AppInsightMonitoringProperties' ApacheTomcatAKSWorkloadDeploymentModelCustomProperties: description: ApacheTomcat workload instance model custom properties. type: object allOf: - $ref: '#/definitions/WorkloadDeploymentModelCustomProperties' properties: apacheTomcatAksWorkloadDeploymentProperties: $ref: '#/definitions/ApacheTomcatAKSWorkloadDeployment' ApacheTomcatWebApplication: description: ApacheTomcat web application. type: object properties: applicationId: description: Gets or sets the web application id. type: string applicationName: description: Gets or sets the web application name. type: string applicationScratchPath: description: Gets or sets application scratch path. type: string webServerId: description: Gets or sets the web server id. type: string webServerName: description: Gets or sets the web server name. type: string displayName: description: Gets or sets the display name. type: string directories: description: Gets or sets application directories. type: array items: $ref: '#/definitions/WebApplicationDirectory' configurations: description: Gets or sets application configuration. type: array items: $ref: '#/definitions/WebApplicationConfiguration' path: $ref: '#/definitions/DirectoryPath' bindings: description: Gets or sets the bindings for the application. type: array items: $ref: '#/definitions/Binding' primaryFramework: $ref: '#/definitions/WebApplicationFramework' discoveredFrameworks: description: Gets or sets the discovered frameworks of application. type: array items: $ref: '#/definitions/WebApplicationFramework' requests: $ref: '#/definitions/ResourceRequirements' limits: $ref: '#/definitions/ResourceRequirements' ApacheTomcatWorkloadInstanceModelCustomProperties: description: ApacheTomcat workload instance model custom properties. type: object allOf: - $ref: '#/definitions/WorkloadInstanceModelCustomProperties' properties: apacheTomcatWebApplication: $ref: '#/definitions/ApacheTomcatWebApplication' AppInsightMonitoringProperties: description: Class for app insight monitoring properties. type: object properties: subscriptionId: description: Gets or sets the subscription id of the resource. type: string resourceGroup: description: Gets or sets the resource group of the resource. type: string appInsightsName: description: Gets or sets the app insights name. type: string region: description: Gets or sets the region. type: string isEnabled: description: Gets or sets a value indicating whether monitoring is enabled. type: boolean secretStoreDetails: $ref: '#/definitions/SecretStoreDetails' AppServiceSettingSecretStoreProperties: type: object allOf: - $ref: '#/definitions/SecretStoreProperties' properties: tenantId: type: string subscriptionId: type: string resourceGroup: type: string appServiceName: type: string ArmError: description: ARM error. type: object properties: error: $ref: '#/definitions/ArmErrorInfo' ArmErrorInfo: description: Arm error information. type: object properties: code: description: Gets or sets the error code returned by the service. type: string message: description: Gets or sets error Message returned by the service. type: string AutomationArtifact: description: Class for automation artifact. type: object properties: status: description: Gets or sets the status of automation artifacts. enum: - NotGenerated - Generated type: string x-ms-enum: name: AutomationArtifactStatus modelAsString: true azureFileShareProfile: $ref: '#/definitions/AzureFileShareHydrationProfile' artifacts: description: Gets or sets the artifacts. type: object additionalProperties: type: string AzureFileShareHydrationProfile: description: "Azure file share profile for hydration of application folders not mounted on\r\nthe container file system." type: object properties: azureFileShareName: description: Gets or sets the name of the azure file share. type: string azureFileShareSubscriptionId: description: Gets or sets the subscription id of the azure file share. type: string azureFileShareResourceGroup: description: Gets or sets the name of the azure file share resource group. type: string azureFileShareStorageAccount: description: Gets or sets the name of the azure file share storage account. type: string azureFileShareDirPath: description: >- Gets or sets the cloud directory path of the directory on azure file share. type: string Binding: description: Binding for a web application. type: object properties: id: description: Gets the ID. type: string readOnly: true port: description: Gets or sets the application port. type: string portMapping: $ref: '#/definitions/PortMapping' cert: $ref: '#/definitions/Cert' hostName: description: Gets or sets the binding host name. type: string protocol: description: Gets or sets the protocol. type: string ipAddress: description: Gets or sets the IP Address. type: string BuildContainerImageModel: description: BuildContainerImage model. type: object properties: properties: $ref: '#/definitions/ContainerImageProperties' BuildContainerImageWorkflowModelCustomProperties: description: Build container image workflow model custom properties. type: object allOf: - $ref: '#/definitions/WorkflowModelCustomProperties' properties: containerImageProperties: allOf: - $ref: '#/definitions/ContainerImageProperties' readOnly: true Cert: description: WebApplication certificate. type: object properties: certNeeded: description: Gets or sets a value indicating whether certificate is needed or not. type: boolean certProvided: description: >- Gets or sets a value indicating whether certificate is provided or not. type: boolean certData: format: byte description: Gets or sets the Certificate data. type: string secretStore: description: Gets or sets the type of secret store for the certificate. enum: - None - KubeSecret - KeyVaultSecret - AppServiceAppSettings type: string x-ms-enum: name: SecretStoreType modelAsString: true ContainerImageProperties: description: Class for container image properties. type: object properties: id: description: Gets the ID. type: string readOnly: true dockerfile: description: Gets or sets the dockerfile for the container image. type: string registryProperties: $ref: '#/definitions/ACRProperties' imageTag: description: Gets or sets the container image tag. type: string imageName: description: Gets or sets the container image name. type: string runId: description: Gets or sets the RunId. type: string runStatus: description: Gets or sets the RunStatus. type: string DeployedResourceModel: description: DeployedResource model. type: object properties: properties: $ref: '#/definitions/DeployedResourceModelProperties' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true DeployedResourceModelCollection: description: DeployedResource model collection. type: object properties: value: description: Gets or sets the list of deployedResources. type: array items: $ref: '#/definitions/DeployedResourceModel' nextLink: description: Gets or sets the value of next link. type: string DeployedResourceModelProperties: description: DeployedResource properties. type: object properties: resourcesDeployed: description: Gets or sets the list of resources deployed. type: object additionalProperties: type: string workloadDeploymentId: description: Gets or sets the workload deployment id. type: string readOnly: true displayName: description: Gets or sets the name of deployed resources. type: string readOnly: true deploymentTimestamp: format: date-time description: Gets or sets the deployment timestamp. type: string readOnly: true targetAzureService: description: Gets or sets the deployment target service. enum: - AzureKubernetesService - AzureAppServiceContainer - AzureAppServiceNative type: string readOnly: true x-ms-enum: name: WorkloadDeploymentTarget modelAsString: true containerRegistryId: description: Gets or sets the container registry ARM Id. type: string readOnly: true imageName: description: Gets or sets the image name. type: string readOnly: true imageTag: description: Gets or sets the image tag. type: string readOnly: true appIp: description: Gets or sets the app ip address. type: string readOnly: true secretStoreId: description: Gets or sets the secret store ARM Id. type: string customProperties: description: Gets or sets the custom deployed resource properties. type: object additionalProperties: type: string DeployedResourcesProperties: description: Class for deployed resource properties. type: object properties: id: description: Gets or sets the ID. type: string readOnly: true deployedResourceId: description: Gets or sets the deployed resource id. type: string readOnly: true displayName: description: Gets or sets the name of deployed resources. type: string readOnly: true context: description: Gets or sets the context of deployed resources. type: string readOnly: true status: description: Gets or sets the status of deployed resources. type: string readOnly: true type: description: Gets or sets the type of deployed resources. type: string readOnly: true deploymentTimestamp: format: date-time description: Gets or sets the deployment timestamp. type: string readOnly: true isCleanUpDone: description: >- Gets or sets a value indicating whether resources are cleaned up from target. type: boolean readOnly: true isTestMigration: description: Gets or sets a value indicating whether scenario is test migration. type: boolean readOnly: true DirectoryPath: description: Second level entity for virtual directories. type: object properties: id: description: Gets the ID. type: string readOnly: true virtual: description: Gets or sets the virtual path for the directory. type: string physical: description: Gets or sets the physical path of the directory on the web server. type: string EnableReplicationWorkflowModelCustomProperties: description: Enable replication workflow model custom properties. type: object allOf: - $ref: '#/definitions/WorkflowModelCustomProperties' properties: workloadInstanceProperties: allOf: - $ref: '#/definitions/WorkloadInstanceModelProperties' readOnly: true ErrorModel: description: Error model. type: object properties: id: description: Gets the ID. type: string readOnly: true code: description: Gets or sets the error code. type: string readOnly: true type: description: Gets or sets the error type. type: string readOnly: true severity: description: Gets or sets the error severity. type: string readOnly: true creationTime: format: date-time description: Gets or sets the creation time of error. type: string readOnly: true message: description: Gets or sets the error message. type: string readOnly: true causes: description: Gets or sets the possible causes of error. type: string readOnly: true recommendation: description: Gets or sets the recommended action to resolve error. type: string readOnly: true GmsaAuthenticationProperties: description: >- Class for GMSA authentication details to configure Active Directory connectivity. type: object properties: configurationState: description: Gets or sets the current state of GMSA configuration. enum: - NotApplicable - Pending - InProgress - Completed - Failed type: string readOnly: true x-ms-enum: name: GmsaConfigurationState modelAsString: true gmsaAccountName: description: Gets or sets the name to be used for GMSA. type: string gmsaUsername: description: >- Gets or sets username of the user having authorization to access GMSA on Active Directory. type: string gmsaUserPassword: description: >- Gets or sets the password of the user specified by RestApi.Controllers.V2022_05_01_preview.Models.WorkloadDeployment.Gmsa.GmsaAuthenticationProperties.GmsaUsername. type: string adDomainControllerDns: description: >- Gets or sets the list of dns server that can resolve the Active Directory Domain Name/Address. type: string adDomainFqdn: description: >- Gets or sets the FQDN of the Active Directory Domain. For e.g. 'contoso.local', 'fareast.corp.microsoft.com' etc. type: string domainControllerAddress: description: >- Gets or sets the address of the Active Directory Domain Controller running Domain Services. type: string domainAdminUsername: description: >- Gets or sets the name of the user having admin rights on the Active Directory Domain Controller. type: string domainAdminPassword: description: >- Gets or sets the password of the user specified by RestApi.Controllers.V2022_05_01_preview.Models.WorkloadDeployment.Gmsa.GmsaAuthenticationProperties.DomainAdminUsername. type: string akvProperties: $ref: '#/definitions/KeyVaultSecretStoreProperties' gmsaCredSpecName: description: Gets Cred Spec Name to be used. type: string readOnly: true gmsaSecretName: description: Gets name of the secret where GMSA secret is stored in the KeyVault. type: string readOnly: true HealthErrorModel: description: Health error model. type: object properties: affectedResourceType: description: Gets or sets the type of affected resource type. type: string affectedResourceCorrelationIds: description: "Gets or sets the list of affected resource correlation Ids. This can be used to\r\nuniquely identify the count of items affected by a specific category and severity\r\nas well as count of item affected by an specific issue." type: array items: type: string childErrors: description: Gets or sets a list of child health errors associated with this error. type: array items: $ref: '#/definitions/InnerHealthErrorModel' id: description: Gets the ID. type: string readOnly: true code: description: Gets or sets the error code. type: string readOnly: true healthCategory: description: Gets or sets the health category. type: string readOnly: true category: description: Gets or sets the error category. type: string readOnly: true severity: description: Gets or sets the error severity. type: string readOnly: true source: description: Gets or sets the error source. type: string readOnly: true creationTime: format: date-time description: Gets or sets the error creation time. type: string readOnly: true isCustomerResolvable: description: >- Gets or sets a value indicating whether the error is customer resolvable. type: boolean readOnly: true summary: description: Gets or sets the error summary. type: string readOnly: true message: description: Gets or sets the error message. type: string readOnly: true causes: description: Gets or sets possible causes of the error. type: string readOnly: true recommendation: description: Gets or sets recommended action to resolve the error. type: string readOnly: true IISAKSWorkloadDeployment: description: IIS AKS workload deployment. type: object properties: clusterProperties: $ref: '#/definitions/AKSDeploymentProperties' deploymentSpec: $ref: '#/definitions/AKSDeploymentSpecification' deploymentHistory: description: Gets or sets the deployment history. type: array items: $ref: '#/definitions/DeployedResourcesProperties' readOnly: true authenticationProperties: $ref: '#/definitions/GmsaAuthenticationProperties' deploymentNamePrefix: description: Gets or sets the deployment name prefix. type: string automationArtifactProperties: $ref: '#/definitions/AutomationArtifact' directories: description: Gets or sets application directories. type: array items: $ref: '#/definitions/WebApplicationDirectory' configurations: description: Gets or sets application configuration. type: array items: $ref: '#/definitions/WebApplicationConfiguration' containerImageProperties: $ref: '#/definitions/ContainerImageProperties' buildContainerImages: description: Gets or sets the build container images. type: array items: $ref: '#/definitions/ContainerImageProperties' bindings: description: Gets or sets the bindings for the application. type: array items: $ref: '#/definitions/Binding' requests: $ref: '#/definitions/ResourceRequirements' limits: $ref: '#/definitions/ResourceRequirements' targetPlatformIdentity: description: Gets or sets the target platform managed identity. type: string monitoringProperties: $ref: '#/definitions/AppInsightMonitoringProperties' IISAKSWorkloadDeploymentModelCustomProperties: description: IIS workload instance model custom properties. type: object allOf: - $ref: '#/definitions/WorkloadDeploymentModelCustomProperties' properties: iisAksWorkloadDeploymentProperties: $ref: '#/definitions/IISAKSWorkloadDeployment' IISApplicationDetails: description: IISApplication details. type: object properties: id: description: Gets the ID. type: string readOnly: true applicationPoolName: description: Gets or sets the application pool name. type: string managedPipelineMode: description: Gets or sets the managed pipeline mode. type: string runtimeVersion: description: Gets or sets the runtime version. type: string enable32BitApiOnWin64: description: >- Gets or sets a value indicating whether 32 bit applications are allowed to run on 64 bit. type: boolean path: $ref: '#/definitions/DirectoryPath' directories: description: Gets or sets the list of directories. type: array items: $ref: '#/definitions/DirectoryPath' IISVirtualApplicationDetails: description: IIS virtual application details. type: object properties: id: description: Gets the ID. type: string readOnly: true isVirtualDirectory: description: >- Gets a value indicating whether the application corresponds to a directory. type: boolean readOnly: true path: $ref: '#/definitions/DirectoryPath' directories: description: Gets or sets the list of directories. type: array items: $ref: '#/definitions/DirectoryPath' IISWebApplication: description: IISWeb application. type: object properties: applications: description: Gets or sets the list of applications for the IIS web site. type: array items: $ref: '#/definitions/IISApplicationDetails' virtualApplications: description: Gets or sets the list of application units for the web site. type: array items: $ref: '#/definitions/IISVirtualApplicationDetails' iisWebServer: $ref: '#/definitions/IISWebServer' applicationId: description: Gets or sets the web application id. type: string applicationName: description: Gets or sets the web application name. type: string applicationScratchPath: description: Gets or sets application scratch path. type: string webServerId: description: Gets or sets the web server id. type: string webServerName: description: Gets or sets the web server name. type: string displayName: description: Gets or sets the display name. type: string directories: description: Gets or sets application directories. type: array items: $ref: '#/definitions/WebApplicationDirectory' configurations: description: Gets or sets application configuration. type: array items: $ref: '#/definitions/WebApplicationConfiguration' path: $ref: '#/definitions/DirectoryPath' bindings: description: Gets or sets the bindings for the application. type: array items: $ref: '#/definitions/Binding' primaryFramework: $ref: '#/definitions/WebApplicationFramework' discoveredFrameworks: description: Gets or sets the discovered frameworks of application. type: array items: $ref: '#/definitions/WebApplicationFramework' requests: $ref: '#/definitions/ResourceRequirements' limits: $ref: '#/definitions/ResourceRequirements' IISWebServer: description: IISWeb server. type: object properties: serverId: description: Gets or sets the web server id. type: string serverName: description: Gets or sets the web server name. type: string rootConfigurationLocation: description: Gets or sets the server root configuration location. type: string version: description: Gets or sets the server version. type: string machines: description: Gets or sets the list of machines. type: array items: type: string webApplications: description: Gets or sets the list of web applications. type: array items: type: string displayName: description: Gets or sets the display name. type: string serverFqdn: description: Gets or sets the server FQDN. type: string ipAddresses: description: Gets or sets list of ip addresses. type: array items: type: string runAsAccountId: description: Gets or sets the run as account id. type: string operatingSystemDetails: $ref: '#/definitions/OperatingSystemDetails' IISWorkloadInstanceModelCustomProperties: description: IIS workload instance model custom properties. type: object allOf: - $ref: '#/definitions/WorkloadInstanceModelCustomProperties' properties: iisWebApplication: $ref: '#/definitions/IISWebApplication' containerName: description: Gets or sets the container Id. type: string fileshareName: description: Gets or sets the fileshare name. type: string IdentityModel: description: Identity model. type: object properties: tenantId: description: >- Gets or sets the tenant Id of the SPN with which MigrateAgent communicates to service. type: string applicationId: description: "Gets or sets the client/application Id of the SPN with which MigrateAgent communicates to\r\nservice." type: string objectId: description: >- Gets or sets the object Id of the SPN with which MigrateAgent communicates to service. type: string audience: description: >- Gets or sets the audience of the SPN with which MigrateAgent communicates to service. type: string aadAuthority: description: >- Gets or sets the authority of the SPN with which MigrateAgent communicates to service. type: string InnerHealthErrorModel: description: Inner health error model. type: object properties: id: description: Gets the ID. type: string readOnly: true code: description: Gets or sets the error code. type: string readOnly: true healthCategory: description: Gets or sets the health category. type: string readOnly: true category: description: Gets or sets the error category. type: string readOnly: true severity: description: Gets or sets the error severity. type: string readOnly: true source: description: Gets or sets the error source. type: string readOnly: true creationTime: format: date-time description: Gets or sets the error creation time. type: string readOnly: true isCustomerResolvable: description: >- Gets or sets a value indicating whether the error is customer resolvable. type: boolean readOnly: true summary: description: Gets or sets the error summary. type: string readOnly: true message: description: Gets or sets the error message. type: string readOnly: true causes: description: Gets or sets possible causes of the error. type: string readOnly: true recommendation: description: Gets or sets recommended action to resolve the error. type: string readOnly: true KeyVaultSecretStoreProperties: type: object allOf: - $ref: '#/definitions/SecretStoreProperties' properties: tenantId: type: string subscriptionId: type: string resourceGroup: type: string keyvaultName: type: string managedIdentityProperties: $ref: '#/definitions/ManagedIdentityProperties' KubeSecretStoreProperties: type: object allOf: - $ref: '#/definitions/SecretStoreProperties' ManagedIdentityProperties: type: object properties: tenantId: type: string subscriptionId: type: string resourceGroup: type: string managedIdentityName: type: string clientId: type: string principalId: type: string MigrateAgentModel: description: MigrateAgent model. type: object properties: properties: $ref: '#/definitions/MigrateAgentModelProperties' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true MigrateAgentModelCollection: description: MigrateAgent model collection. type: object properties: value: description: Gets or sets the list of agents. type: array items: $ref: '#/definitions/MigrateAgentModel' nextLink: description: Gets or sets the value of next link. type: string MigrateAgentModelCustomProperties: description: MigrateAgent model custom properties. required: - instanceType type: object properties: instanceType: description: Gets or sets the instance type. type: string x-ms-discriminator-value: IISWorkload discriminator: instanceType MigrateAgentModelProperties: description: MigrateAgent model properties. type: object properties: correlationId: description: Gets or sets the MigrateAgent correlation Id. type: string readOnly: true machineId: description: Gets or sets the machine Id where MigrateAgent is running. type: string machineName: description: Gets or sets the machine name where MigrateAgent is running. type: string authenticationIdentity: $ref: '#/definitions/IdentityModel' isResponsive: description: Gets or sets a value indicating whether MigrateAgent is responsive. type: boolean readOnly: true lastHeartbeat: format: date-time description: >- Gets or sets the time when last heartbeat was sent by the MigrateAgent. type: string readOnly: true versionNumber: description: Gets or sets the MigrateAgent version. type: string readOnly: true provisioningState: description: Gets or sets the provisioning state of the MigrateAgent. enum: - Canceled - Creating - Deleting - Deleted - Failed - Succeeded - Updating type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true healthErrors: description: Gets or sets the list of health errors. type: array items: $ref: '#/definitions/HealthErrorModel' readOnly: true customProperties: $ref: '#/definitions/MigrateAgentModelCustomProperties' MigrateWorkflowModelCustomProperties: description: Migrate workflow model custom properties. type: object allOf: - $ref: '#/definitions/WorkflowModelCustomProperties' properties: deployedResourcesProperties: allOf: - $ref: '#/definitions/DeployedResourcesProperties' readOnly: true MigrationConfiguration: description: MigrationConfiguration properties. type: object properties: storageAccountResourceId: description: Gets or sets the storage account resource Id. type: string keyVaultResourceId: description: Gets or sets the key vault resource Id. type: string migrationSolutionResourceId: description: Gets or sets the migration solution resource Id. type: string ModernizeProjectModel: description: ModernizeProject model. type: object properties: location: description: Gets or sets the location of the modernizeProject. type: string properties: $ref: '#/definitions/ModernizeProjectModelProperties' identity: $ref: '#/definitions/ResourceIdentity' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true ModernizeProjectModelCollection: description: ModernizeProject model collection. type: object properties: value: description: Gets or sets the list of modernizeProjects. type: array items: $ref: '#/definitions/ModernizeProjectModel' nextLink: description: Gets or sets the value of next link. type: string ModernizeProjectModelProperties: description: ModernizeProject properties. type: object properties: provisioningState: description: Gets or sets the provisioning state of the ModernizeProject. enum: - Canceled - Creating - Deleting - Deleted - Failed - Succeeded - Updating type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true serviceResourceId: description: Gets or sets the service resource Id. type: string readOnly: true serviceEndpoint: description: Gets or sets the service endpoint. type: string readOnly: true migrationConfiguration: $ref: '#/definitions/MigrationConfiguration' ModernizeProjectStatisticsModel: description: ModernizeProject statistics model. type: object properties: properties: $ref: '#/definitions/ModernizeProjectStatisticsModelProperties' ModernizeProjectStatisticsModelProperties: description: ModernizeProject statistics properties. type: object properties: workloadDeploymentStatistics: allOf: - $ref: '#/definitions/WorkloadDeploymentStatisticsModel' readOnly: true jobStatistics: allOf: - $ref: '#/definitions/WorkflowStatisticsModel' readOnly: true workloadInstanceStatistics: allOf: - $ref: '#/definitions/WorkloadInstanceStatisticsModel' readOnly: true modernizeProjectErrors: description: Gets or sets the list of modernizeProject health errors. type: array items: $ref: '#/definitions/HealthErrorModel' readOnly: true OperatingSystemDetails: type: object properties: os: enum: - Windows - Linux type: string x-ms-enum: name: OperatingSystemType modelAsString: true osName: type: string osVersion: type: string osArchitecture: type: string OperationStatus: description: Defines the operation status. type: object properties: id: description: Gets the Id. type: string readOnly: true name: description: Gets the operation name. type: string readOnly: true status: description: "Gets the status of the operation. ARM expects the terminal status to be one of\r\nSucceeded/ Failed/ Canceled. All other values imply that the operation is still running." type: string readOnly: true startTime: description: Gets the start time. type: string readOnly: true endTime: description: Gets the end time. type: string readOnly: true PortMapping: description: WebApplication port mapping. type: object properties: internalPort: format: int32 description: Gets or sets the Internal Port. type: integer externalPort: format: int32 description: Gets or sets the External Port. type: integer ResourceIdentity: type: object properties: principalId: type: string tenantId: type: string type: enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: name: ResourceIdentityTypes modelAsString: true userAssignedIdentities: type: object additionalProperties: $ref: '#/definitions/UserAssignedIdentity' ResourceRequirements: description: Resource Requirements. type: object properties: cpu: description: Gets or sets the Cpu requirement. type: string memory: description: Gets or sets the Memory requirement. type: string SecretStoreDetails: type: object properties: secretStore: enum: - None - KubeSecret - KeyVaultSecret - AppServiceAppSettings type: string x-ms-enum: name: SecretStoreType modelAsString: true secretStoreProperties: $ref: '#/definitions/SecretStoreProperties' SecretStoreProperties: type: object properties: secretStoreId: type: string inputType: type: string readOnly: true SystemDataModel: description: System data required to be defined for Azure resources. type: object properties: createdBy: description: Gets or sets identity that created the resource. type: string createdByType: description: "Gets or sets the type of identity that created the resource: user, application,\r\nmanagedIdentity." type: string createdAt: format: date-time description: Gets or sets the timestamp of resource creation (UTC). type: string lastModifiedBy: description: Gets or sets the identity that last modified the resource. type: string lastModifiedByType: description: "Gets or sets the type of identity that last modified the resource: user, application,\r\nmanagedIdentity." type: string lastModifiedAt: format: date-time description: Gets or sets the timestamp of resource last modification (UTC). type: string TargetStorageProfile: description: Storage profile for the directory on the target container. type: object properties: storageAccessType: description: Gets or sets the target storage access type. enum: - Shared - Exclusive type: string x-ms-enum: name: TargetStorageAccessType modelAsString: true storageProjectionType: description: Gets or sets the target projection type. enum: - ContainerFileSystem - PersistentVolume type: string x-ms-enum: name: TargetStorageProjectionType modelAsString: true hydrationStorageProviderType: description: "Gets or sets the storage provider type on the target.\r\nApplicable when StorageProjectionType is not ContainerFileSystem." enum: - AzureFileShare type: string x-ms-enum: name: TargetHydrationStorageProviderType modelAsString: true persistentVolumeId: description: "Gets or sets the target persistent volume id.\r\nApplicable when StorageProjectionType is PersistentVolume and on using an\r\nexisting PersistentVolume." type: string targetName: description: >- Gets or sets the name of the projected volume on the target environment. type: string targetSize: description: "Gets or sets the storage size on the target.\r\nApplicable when StorageProjectionType is PersistentVolume and on creating a new\r\nPersistentVolume." type: string azureFileShareProfile: $ref: '#/definitions/AzureFileShareHydrationProfile' TaskModel: description: Task model. type: object properties: id: description: Gets the ID. type: string readOnly: true taskName: description: Gets or sets the task name. type: string readOnly: true state: description: Gets or sets the task state. enum: - Pending - Started - Succeeded - Failed - Cancelled - Skipped type: string readOnly: true x-ms-enum: name: TaskState modelAsString: true startTime: format: date-time description: Gets or sets the start time. type: string readOnly: true endTime: format: date-time description: Gets or sets the end time. type: string readOnly: true customProperties: $ref: '#/definitions/TaskModelCustomProperties' TaskModelCustomProperties: description: Task model custom properties. type: object properties: instanceType: description: Gets or sets the instance type. type: string TestMigrateCleanupWorkflowModelCustomProperties: description: Test migrate cleanup workflow model custom properties. type: object allOf: - $ref: '#/definitions/WorkflowModelCustomProperties' properties: comments: description: Gets or sets the test migrate cleanup comments. type: string readOnly: true TestMigrateModel: description: Test migrate model. type: object properties: properties: $ref: '#/definitions/TestMigrateModelProperties' TestMigrateModelProperties: description: Test migrate model properties. type: object properties: customProperties: $ref: '#/definitions/WorkloadDeploymentModelCustomProperties' TestMigrateWorkflowModelCustomProperties: description: Test migrate workflow model custom properties. type: object allOf: - $ref: '#/definitions/WorkflowModelCustomProperties' properties: deployedResourcesProperties: allOf: - $ref: '#/definitions/DeployedResourcesProperties' readOnly: true UpdateModernizeProjectModel: description: Update ModernizeProject model. type: object properties: tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string identity: $ref: '#/definitions/ResourceIdentity' x-ms-azure-resource: true UserAssignedIdentity: type: object properties: principalId: type: string clientId: type: string VMwareMigrateAgentModelCustomProperties: description: VMware MigrateAgent model custom properties. type: object allOf: - $ref: '#/definitions/MigrateAgentModelCustomProperties' properties: vmwareSiteId: description: Gets or sets the master Site Id of the Migrate Agent. type: string fabricFriendlyName: description: Gets or sets the friendly name of the,of the MigrateAgent fabric. type: string WebApplicationConfiguration: description: Class for web application configurations. type: object properties: id: description: Gets the ID. type: string readOnly: true name: description: Gets or sets the configuration name. type: string filePath: description: Gets or sets the configuration file path. type: string localFilePath: description: Gets or sets the configuration local file path. type: string targetFilePath: description: Gets or sets the configuration target file path. type: string section: description: Gets or sets the configuration section in the file. type: string type: description: Gets or sets the configuration type. enum: - IISConnectionString - IISAuthentication - ApacheTomcatContextResource type: string x-ms-enum: name: ConfigurationType modelAsString: true isDeploymentTimeEditable: description: >- Gets or sets a value indicating whether the configuration is edited or not by the user. type: boolean value: description: Gets or sets the configuration value. type: string identifier: description: Gets or sets the identifier for the configuration. type: string secretStoreDetails: $ref: '#/definitions/SecretStoreDetails' WebApplicationDirectory: description: WebApplication directory structure. type: object properties: id: description: Gets the unique id corresponding to the application directory. type: string readOnly: true isEditable: description: "Gets or sets a value indicating whether the directory object is editable.\r\nTrue when the directory is added as an optional directory, false when discovery is done\r\nmanually." type: boolean sourcePaths: description: Gets or sets the paths of the directory on the source machine. type: array items: type: string sourceSize: description: Gets or sets the size of the directory on the source machine. type: string storageProfile: $ref: '#/definitions/TargetStorageProfile' WebApplicationFramework: description: Framework specific data for a web application. type: object properties: id: description: Gets the ID. type: string readOnly: true name: description: Gets or sets Name of the framework. type: string version: description: Gets or sets Version of the framework. type: string WorkflowModel: description: Workflow model. type: object properties: properties: $ref: '#/definitions/WorkflowModelProperties' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true WorkflowModelCollection: description: Workflow model collection. type: object properties: value: description: Gets or sets the list of workflows. type: array items: $ref: '#/definitions/WorkflowModel' nextLink: description: Gets or sets the value of next link. type: string WorkflowModelCustomProperties: description: Workflow model custom properties. required: - instanceType type: object properties: instanceType: description: Gets or sets the instance type. enum: - SampleWorkflow - EnableReplicationWorkflow - StopReplicationWorkflow - BuildContainerImageWorkflow - MigrateWorkflow - TestMigrateWorkflow - TestMigrateCleanupWorkflow - CompleteMigrationWorkflow - DisableReplicationWorkflow type: string x-ms-enum: name: WorkflowType modelAsString: true affectedObjectDetails: description: Gets or sets any custom properties of the affected object. type: object additionalProperties: type: string readOnly: true x-ms-discriminator-value: SampleWorkflow discriminator: instanceType WorkflowModelProperties: description: Workflow model properties. type: object properties: displayName: description: Gets or sets the friendly display name. type: string readOnly: true state: description: Gets or sets the workflow state. enum: - Pending - Started - Cancelling - Succeeded - Failed - Cancelled - CompletedWithInformation - CompletedWithWarnings - CompletedWithErrors type: string readOnly: true x-ms-enum: name: WorkflowState modelAsString: true startTime: format: date-time description: Gets or sets the start time. type: string readOnly: true endTime: format: date-time description: Gets or sets the end time. type: string readOnly: true objectId: description: Gets or sets the affected object Id. type: string readOnly: true objectName: description: Gets or sets the affected object name. type: string readOnly: true objectInternalId: description: Gets or sets the affected object internal Id. type: string readOnly: true objectInternalName: description: Gets or sets the affected object internal name. type: string readOnly: true objectType: description: Gets or sets the object type. enum: - ModernizeProject - MigrateAgent - WorkloadInstance - WorkloadDeployment - ReplicationPostAction type: string readOnly: true x-ms-enum: name: WorkflowObjectType modelAsString: true workloadInstanceProviderId: description: Gets or sets the workload instance provider. type: string readOnly: true workloadDeploymentProviderId: description: Gets or sets the workload deployment provider. type: string readOnly: true allowedActions: description: Gets or sets the list of allowed actions on the workflow. type: array items: type: string readOnly: true activityId: description: Gets or sets the workflow activity id. type: string readOnly: true tasks: description: Gets or sets the list of tasks. type: array items: $ref: '#/definitions/TaskModel' readOnly: true errors: description: Gets or sets the list of errors. type: array items: $ref: '#/definitions/ErrorModel' readOnly: true customProperties: $ref: '#/definitions/WorkflowModelCustomProperties' WorkflowStatisticsModel: description: Workflow statistics. type: object properties: count: format: int64 description: Gets or sets the resource count. type: integer readOnly: true categorizedCounts: description: Gets or sets the categorized resource counts. type: object additionalProperties: format: int64 type: integer readOnly: true WorkloadDeploymentModel: description: Workload deployment model. type: object properties: properties: $ref: '#/definitions/WorkloadDeploymentModelProperties' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true WorkloadDeploymentModelCollection: description: Workload deployment model collection. type: object properties: value: description: Gets or sets the list of workload deployments. type: array items: $ref: '#/definitions/WorkloadDeploymentModel' nextLink: description: Gets or sets the value of next link. type: string WorkloadDeploymentModelCustomProperties: description: Workload deployment model custom properties. required: - instanceType type: object properties: instanceType: description: Gets or sets the instance type. enum: - IISAKSWorkloadDeployment - ApacheTomcatAKSWorkloadDeployment type: string x-ms-enum: name: WorkloadDeploymentType modelAsString: true discriminator: instanceType x-ms-discriminator-value: IISAKSWorkloadDeployment WorkloadDeploymentModelProperties: description: Workload deployment model properties. type: object properties: provisioningState: description: Gets or sets the provisioning state of the workload deployment. enum: - Canceled - Creating - Deleting - Deleted - Failed - Succeeded - Updating type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true status: description: Gets or sets the workload deployment status. enum: - None - InitialReplication - ReplicationFailed - ImageBuildPending - ImageBuildInProgress - ImageBuildFailed - TestMigrating - CleanUpPending - CleanUpInProgress - ReadyToMigrate - Migrating - Migrated - MigrationFailed type: string readOnly: true x-ms-enum: name: WorkloadStatus modelAsString: true statusDescription: description: Gets or sets the workload deployment status description. type: string readOnly: true testMigrationStatus: description: Gets or sets the test migrate state. enum: - None - ImageBuildPending - ImageBuildInProgress - ImageBuildFailed - ReadyToTestMigrate - TestMigrationInProgress - TestMigrated - Failed - CleanupInProgress - CleanedUp type: string readOnly: true x-ms-enum: name: ClientFacingTestMigrateStatus modelAsString: true testMigrationStatusDescription: description: Gets or sets the Test migrate state description. type: string readOnly: true migrationStatus: description: Gets or sets the migrate state. enum: - None - ImageBuildPending - ImageBuildInProgress - ImageBuildFailed - ReadyToTestMigrate - ReadyToMigrate - TestMigrating - TestMigrated - TestMigrateCleanupInProgress - Migrating - Migrated - Failed type: string readOnly: true x-ms-enum: name: ClientFacingMigrateStatus modelAsString: true migrationStatusDescription: description: Gets or sets the migrate state description. type: string readOnly: true displayName: description: Gets or sets the display name. type: string targetPlatform: description: Gets or sets the deployment target platform. enum: - AzureKubernetesService - AzureAppServiceContainer - AzureAppServiceNative type: string x-ms-enum: name: WorkloadDeploymentTarget modelAsString: true workloadInstanceProperties: $ref: '#/definitions/WorkloadInstanceModelProperties' correlationId: description: Gets or sets the workload deployment correlation Id. type: string readOnly: true lastSuccessfulMigrateTime: format: date-time description: Gets or sets the Last successful unplanned migrate time. type: string readOnly: true lastSuccessfulTestMigrateTime: format: date-time description: Gets or sets the Last successful test migrate time. type: string readOnly: true currentJob: allOf: - $ref: '#/definitions/WorkloadJobProperties' readOnly: true allowedOperations: description: Gets or sets the allowed scenarios on the workload deployment. type: array items: enum: - EnableReplication - DisableReplication - CompleteMigration - BuildContainerImage - Migrate - TestMigrate - TestMigrateCleanup - UpdateProperties type: string x-ms-enum: name: WorkloadScenario modelAsString: true readOnly: true healthErrors: description: Gets or sets the list of health errors. type: array items: $ref: '#/definitions/HealthErrorModel' readOnly: true customProperties: $ref: '#/definitions/WorkloadDeploymentModelCustomProperties' WorkloadDeploymentStatisticsModel: description: Workload deployment statistics. type: object properties: healthErrors: description: Gets or sets the list of health errors. type: array items: $ref: '#/definitions/HealthErrorModel' readOnly: true count: format: int64 description: Gets or sets the resource count. type: integer readOnly: true categorizedCounts: description: Gets or sets the categorized resource counts. type: object additionalProperties: format: int64 type: integer readOnly: true WorkloadInstanceModel: description: Workload instance model. type: object properties: properties: $ref: '#/definitions/WorkloadInstanceModelProperties' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true WorkloadInstanceModelCollection: description: Workload instance model collection. type: object properties: value: description: Gets or sets the list of workload instances. type: array items: $ref: '#/definitions/WorkloadInstanceModel' nextLink: description: Gets or sets the value of next link. type: string WorkloadInstanceModelCustomProperties: description: Workload instance model custom properties. required: - instanceType type: object properties: instanceType: description: Gets or sets the instance type. enum: - IISWorkload - ApacheTomcatWorkload type: string x-ms-enum: name: WorkloadType modelAsString: true webAppArmId: description: Gets or sets the Web application ARM id. type: string webAppSiteName: description: Gets or sets the Web application site name. type: string x-ms-discriminator-value: IISWorkload discriminator: instanceType WorkloadInstanceModelProperties: description: Workload instance model properties. type: object properties: name: description: Gets or sets the workload instance name. type: string provisioningState: description: Gets or sets the provisioning state of the workload instance. enum: - Canceled - Creating - Deleting - Deleted - Failed - Succeeded - Updating type: string readOnly: true x-ms-enum: name: ProvisioningState modelAsString: true migrateAgentId: description: >- Gets or sets the migrate agent id associated with the workload instance. type: string displayName: description: Gets or sets the display name. type: string sourcePlatform: description: Gets or sets the source platform. type: string sourceName: description: Gets or sets the source name. type: string replicationHealth: description: Gets or sets the replication health of the workload instance. enum: - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: HealthStatus modelAsString: true replicationStatus: description: Gets or sets the replication state of the workload instance. enum: - None - Scheduled - InitialSync - Completed - Failed type: string readOnly: true x-ms-enum: name: ClientFacingReplicationStatus modelAsString: true replicationStatusDescription: description: Gets or sets the workload replication state description. type: string readOnly: true lastSuccessfulReplicationCycleTime: format: date-time description: Gets or sets the Last successful replication cycle time. type: string readOnly: true healthErrors: description: Gets or sets the list of health errors. type: array items: $ref: '#/definitions/HealthErrorModel' readOnly: true currentJob: allOf: - $ref: '#/definitions/WorkloadJobProperties' readOnly: true allowedOperations: description: Gets or sets the allowed scenarios on the workload instance. type: array items: type: string readOnly: true masterSiteName: description: Gets or Sets the master site name. type: string customProperties: $ref: '#/definitions/WorkloadInstanceModelCustomProperties' WorkloadInstanceStatisticsModel: description: Workload instance statistics. type: object properties: healthErrors: description: Gets or sets the list of health errors. type: array items: $ref: '#/definitions/HealthErrorModel' readOnly: true count: format: int64 description: Gets or sets the resource count. type: integer readOnly: true categorizedCounts: description: Gets or sets the categorized resource counts. type: object additionalProperties: format: int64 type: integer readOnly: true WorkloadJobProperties: description: Workload job properties. type: object properties: scenarioName: description: Gets or sets workload scenario name. type: string readOnly: true id: description: Gets or sets workflow Id. type: string readOnly: true name: description: Gets or sets workflow name. type: string readOnly: true displayName: description: Gets or sets the workflow friendly display name. type: string readOnly: true state: description: Gets or sets workflow state. type: string readOnly: true startTime: format: date-time description: Gets or sets start time of the workflow. type: string readOnly: true endTime: format: date-time description: Gets or sets end time of the workflow. type: string readOnly: true parameters: subscriptionId: in: path name: subscriptionId description: Azure Subscription Id in which project was created. required: true type: string x-ms-parameter-location: method resourceGroupName: in: path name: resourceGroupName description: Name of the Azure Resource Group that project is part of. required: true type: string x-ms-parameter-location: method api-version: in: query name: api-version description: Client Api Version. required: true type: string x-ms-parameter-location: method securityDefinitions: azure_auth: type: oauth2 flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account description: Azure Active Directory OAuth2 Flow security: - azure_auth: - user_impersonation tags: - name: DeployedResource description: Deployed resources controller. - name: MigrateAgent description: MigrateAgent Controller. - name: ModernizeProject description: ModernizeProject Controller. - name: Operations - name: Workflow description: Workflow controller. - name: WorkloadDeployment description: Workload deployments controller. - name: WorkloadInstance description: Workload instance controller.