@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Azure Migrate Hub
@base https://management.azure.com
@version 2018-09-01-preview
@auth OAuth2
@common_fields {subscriptionId: any # Azure Subscription Id in which migrate project was created., resourceGroupName: any # Name of the Azure Resource Group that migrate project is part of., migrateProjectName: any # Name of the Azure Migrate project., api-version: any # Standard request header. Used by service to identify API version used by client.}
@endpoints 23
@hint download_for_search
@toc subscriptions(22), providers(1)

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databaseInstances
@desc Gets a list of database instances in the migrate project.
@optional {continuationToken: any # The continuation token., pageSize: any # The number of items to be returned in a single page. This value is honored only if it is less than the 100., Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databaseInstances/{databaseInstanceName}
@desc Gets a database instance in the migrate project.
@required {databaseInstanceName: any # Unique name of a database instance in Azure migration hub.}
@optional {Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databases
@desc Gets a list of databases in the migrate project.
@optional {continuationToken: any # The continuation token., pageSize: any # The number of items to be returned in a single page. This value is honored only if it is less than the 100., Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/databases/{databaseName}
@desc Gets a database in the migrate project.
@required {databaseName: any # Unique name of a database in Azure migration hub.}
@optional {Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents
@desc Gets a list of events in the migrate project.
@optional {continuationToken: any # The continuation token., pageSize: any # The number of items to be returned in a single page. This value is honored only if it is less than the 100., Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents/{eventName}
@desc Gets an event in the migrate project.
@required {eventName: any # Unique name of an event within a migrate project.}
@returns(200) OK

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/migrateEvents/{eventName}
@desc Delete the migrate event
@required {eventName: any # Unique name of an event within a migrate project.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/machines
@desc Gets a list of machines in the migrate project.
@optional {continuationToken: any # The continuation token., pageSize: any # The number of items to be returned in a single page. This value is honored only if it is less than the 100.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/machines/{machineName}
@desc Gets a machine in the migrate project.
@required {machineName: any # Unique name of a machine in Azure migration hub.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}
@desc Method to get a migrate project.
@returns(200) OK

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}
@desc Method to create or update a migrate project.
@required {body: map # Body with migrate project details.}
@optional {Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK
@returns(201) Created

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}
@desc Update migrate project.
@required {body: map # Body with migrate project details.}
@optional {Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}
@desc Delete the migrate project
@optional {Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/registerTool
@desc Registers a tool with the migrate project.
@required {input: map # Input containing the name of the tool to be registered.}
@optional {Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/refreshSummary
@desc Refresh the summary of the migrate project.
@required {input: map # The goal input which needs to be refreshed.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}
@desc Gets a solution in the migrate project.
@required {solutionName: any # Unique name of a migration solution within a migrate project.}
@returns(200) OK

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}
@desc Creates a solution in the migrate project.
@required {solutionName: any # Unique name of a migration solution within a migrate project., solutionInput: map # The input for the solution.}
@returns(200) OK
@returns(201) Created

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}
@desc Update solution.
@required {solutionName: any # Unique name of a migration solution within a migrate project., solutionInput: map # The input for the solution.}
@returns(200) OK

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}
@desc Delete the solution
@required {solutionName: any # Unique name of a migration solution within a migrate project.}
@optional {Accept-Language: any # Standard request header. Used by service to respond to client in appropriate language.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions
@desc Gets the list of solutions in the migrate project.
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}/getConfig
@desc Gets the config for the solution in the migrate project.
@required {solutionName: any # Unique name of a migration solution within a migrate project.}
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}/cleanupData
@desc Cleanup the solution data in the migrate project.
@required {solutionName: any # Unique name of a migration solution within a migrate project.}
@returns(200) OK

@endgroup

@group providers
@endpoint GET /providers/Microsoft.Migrate/operations
@desc Get list of operations supported in the API.
@returns(200) OK. Returns list of operations.

@endgroup

@end
