swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector GroupsOperations API schemes: - https tags: - name: GroupsOperations paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups : get: operationId: microsoftAzureGroupsoperationsListbyassessmentproject tags: - GroupsOperations description: List Group resources by AssessmentProject parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: projectName in: path description: Assessment Project Name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/GroupListResult' default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: GroupsOperations_ListByAssessmentProject_MaximumSet_Gen: $ref: ./examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName} : get: operationId: microsoftAzureGroupsoperationsGet tags: - GroupsOperations description: Get a Group parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: projectName in: path description: Assessment Project Name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: groupName in: path description: Group ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/Group' default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: GroupsOperations_Get_MaximumSet_Gen: $ref: ./examples/GroupsOperations_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname put: operationId: microsoftAzureGroupsoperationsCreate tags: - GroupsOperations description: Create a Group parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: projectName in: path description: Assessment Project Name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: groupName in: path description: Group ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/Group' responses: '200': description: Resource 'Group' update operation succeeded schema: $ref: '#/definitions/Group' '201': description: Resource 'Group' create operation succeeded schema: $ref: '#/definitions/Group' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true x-ms-examples: GroupsOperations_Create_MaximumSet_Gen: $ref: ./examples/GroupsOperations_Create_MaximumSet_Gen.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname delete: operationId: microsoftAzureGroupsoperationsDelete tags: - GroupsOperations description: Delete a Group parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: projectName in: path description: Assessment Project Name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: groupName in: path description: Group ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ responses: '200': description: Resource deleted successfully. '204': description: Resource deleted successfully. default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: GroupsOperations_Delete_MaximumSet_Gen: $ref: ./examples/GroupsOperations_Delete_MaximumSet_Gen.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Groups Groupname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/updateMachines : post: operationId: microsoftAzureGroupsoperationsUpdatemachines tags: - GroupsOperations summary: Microsoft Azure Update Machines In Group description: Update machines in group by adding or removing machines. parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: projectName in: path description: Assessment Project Name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: groupName in: path description: Group ARM name required: true type: string pattern: ^[^<>&:\?/#]{1,260}$ - name: body in: body description: The content of the action request required: true schema: $ref: '#/definitions/UpdateGroupBody' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/Group' '202': description: Resource operation accepted. headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true x-ms-examples: GroupsOperations_UpdateMachines_MaximumSet_Gen: $ref: ./examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json definitions: GroupType: type: string enum: - Default - Import x-ms-enum: name: GroupType modelAsString: true GroupStatus: type: string enum: - Created - Updated - Running - Completed - Invalid x-ms-enum: name: GroupStatus modelAsString: true UpdateGroupBody: type: object description: Properties of group update. properties: eTag: type: string description: For optimistic concurrency control. properties: $ref: '#/definitions/GroupBodyProperties' description: Properties of the group. GroupListResult: type: object description: The response of a Group list operation. properties: value: type: array description: The Group items on this page items: $ref: '#/definitions/Group' nextLink: type: string format: uri description: The link to the next page of items required: - value AzureResourceProperties: type: object description: Common properties for all azure tracked and proxy resources. properties: provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. ProvisioningState: type: string description: The status of the current operation. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: Resource is being Provisioned. - name: Updating value: Updating description: Resource is being Updated. - name: Deleting value: Deleting description: Resource is being Deleted. - name: Accepted value: Accepted description: Resource is being Accepted. GroupBodyProperties: type: object description: Body properties of group update. properties: operationType: $ref: '#/definitions/GroupUpdateOperation' description: Whether to add or remove the machines. machines: type: array description: List of machine names that are part of this group. items: type: string GroupUpdateOperation: type: string enum: - Add - Remove x-ms-enum: name: GroupUpdateOperation modelAsString: true Group: type: object description: Group resource. properties: properties: $ref: '#/definitions/GroupProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource AssessmentType: type: string enum: - Unknown - MachineAssessment - AvsAssessment - SqlAssessment - WebAppAssessment x-ms-enum: name: AssessmentType modelAsString: true GroupProperties: type: object description: Properties of group resource. properties: groupStatus: $ref: '#/definitions/GroupStatus' description: Whether the group has been created and is valid. readOnly: true machineCount: type: integer format: int32 description: Number of machines part of this group. readOnly: true assessments: type: array description: List of References to Assessments created on this group. items: type: string readOnly: true supportedAssessmentTypes: type: array description: List of assessment types supported on this group. items: $ref: '#/definitions/AssessmentType' areAssessmentsRunning: type: boolean description: If the assessments are in running state. readOnly: true createdTimestamp: type: string format: date-time description: Time when this group was created. Date-Time represented in ISO-8601 format. readOnly: true updatedTimestamp: type: string format: date-time description: Time when this group was last updated. Date-Time represented in ISO-8601 format. readOnly: true groupType: $ref: '#/definitions/GroupType' description: The type of group. x-ms-mutability: - read - create allOf: - $ref: '#/definitions/AzureResourceProperties' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'