swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ModernizeProject API description: ModernizeProject Controller. schemes: - https tags: - name: ModernizeProject description: ModernizeProject Controller. paths: ? /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 definitions: 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 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 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 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 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' 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 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 ArmError: description: ARM error. type: object properties: error: $ref: '#/definitions/ArmErrorInfo' 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 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 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' 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 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 UserAssignedIdentity: type: object properties: principalId: type: string clientId: type: string ModernizeProjectStatisticsModel: description: ModernizeProject statistics model. type: object properties: properties: $ref: '#/definitions/ModernizeProjectStatisticsModelProperties' 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 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 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 parameters: 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 subscriptionId: in: path name: subscriptionId description: Azure Subscription Id in which project was created. required: true type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'