Microsoft Azure AssessmentProjectsOperations API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Migrate Assessment Service Assessment…
  version: 2023-04-01-preview
  description: Azure Migrate Resource Provider management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: AssessmentProjectsOperations
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects:
    get:
      operationId: microsoftAzureAssessmentprojectsoperationsListbysubscription
      tags:
      - AssessmentProjectsOperations
      description: List AssessmentProject resources by subscription ID
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentProjectListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen:
          $ref: ./examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Migrate…
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects:
    get:
      operationId: microsoftAzureAssessmentprojectsoperationsListbyresourcegroup
      tags:
      - AssessmentProjectsOperations
      description: List AssessmentProject resources by resource 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
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentProjectListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen:
          $ref: ./examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}
  : get:
      operationId: microsoftAzureAssessmentprojectsoperationsGet
      tags:
      - AssessmentProjectsOperations
      description: Get a 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
        schema:
          type: string
          pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentProject'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        AssessmentProjectsOperations_Get_MaximumSet_Gen:
          $ref: ./examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      operationId: microsoftAzureAssessmentprojectsoperationsCreate
      tags:
      - AssessmentProjectsOperations
      description: Create a 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
        schema:
          type: string
          pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: Resource 'AssessmentProject' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentProject'
        '201':
          description: Resource 'AssessmentProject' create operation succeeded
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentProject'
        default:
          description: An unexpected error response.
          content:
            application/json:
              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:
        AssessmentProjectsOperations_Create_MaximumSet_Gen:
          $ref: ./examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssessmentProject'
        description: Resource create parameters.
        required: true
    patch:
      operationId: microsoftAzureAssessmentprojectsoperationsUpdate
      tags:
      - AssessmentProjectsOperations
      description: Update a 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
        schema:
          type: string
          pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentProject'
        '202':
          description: Resource update request accepted.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            application/json:
              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:
        AssessmentProjectsOperations_Update_MaximumSet_Gen:
          $ref: ./examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssessmentProjectUpdate'
        description: The resource properties to be updated.
        required: true
    delete:
      operationId: microsoftAzureAssessmentprojectsoperationsDelete
      tags:
      - AssessmentProjectsOperations
      description: Delete a 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
        schema:
          type: string
          pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        AssessmentProjectsOperations_Delete_MaximumSet_Gen:
          $ref: ./examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    ProjectProperties:
      type: object
      description: Properties of a project.
      properties:
        createdTimestamp:
          type: string
          format: date-time
          description: Time when this project was created. Date-Time represented in ISO-8601 format.
          readOnly: true
        updatedTimestamp:
          type: string
          format: date-time
          description: 'Time when this project was last updated. Date-Time represented in ISO-8601

            format.'
          readOnly: true
        serviceEndpoint:
          type: string
          description: Endpoint at which the collector agent can call agent REST API.
          readOnly: true
        assessmentSolutionId:
          type: string
          description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects.
        projectStatus:
          $ref: '#/components/schemas/ProjectStatus'
          description: Assessment project status.
        customerWorkspaceId:
          type: string
          description: The ARM id of service map workspace created by customer.
        customerWorkspaceLocation:
          type: string
          description: Location of service map workspace created by customer.
        publicNetworkAccess:
          type: string
          description: 'This value can be set to ''enabled'' to avoid breaking changes on existing

            customer resources and templates. If set to ''disabled'', traffic over public

            interface is not allowed, and private endpoint connections would be the

            exclusive access method.'
        privateEndpointConnections:
          type: array
          description: The list of private endpoint connections to the project.
          items:
            $ref: '#/components/schemas/PrivateEndpointConnection'
          readOnly: true
        customerStorageAccountArmId:
          type: string
          description: 'The ARM id of the storage account used for interactions when public access is

            disabled.'
      allOf:
      - $ref: '#/components/schemas/AzureResourceProperties'
    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.
    AssessmentProjectUpdate:
      type: object
      description: The type used for update operations of the AssessmentProject.
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
        properties:
          $ref: '#/components/schemas/AssessmentProjectUpdateProperties'
          x-ms-client-flatten: true
    AssessmentProjectListResult:
      type: object
      description: The response of a AssessmentProject list operation.
      properties:
        value:
          type: array
          description: The AssessmentProject items on this page
          items:
            $ref: '#/components/schemas/AssessmentProject'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    PrivateEndpointConnection:
      type: object
      description: Private endpoint connection resource.
      properties:
        properties:
          $ref: ../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties
          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
    AssessmentProject:
      type: object
      description: An Assessment project site resource.
      properties:
        properties:
          $ref: '#/components/schemas/ProjectProperties'
          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/TrackedResource
    AssessmentProjectUpdateProperties:
      type: object
      description: The updatable properties of the AssessmentProject.
      properties:
        assessmentSolutionId:
          type: string
          description: Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects.
        projectStatus:
          $ref: '#/components/schemas/ProjectStatus'
          description: Assessment project status.
        customerWorkspaceId:
          type: string
          description: The ARM id of service map workspace created by customer.
        customerWorkspaceLocation:
          type: string
          description: Location of service map workspace created by customer.
        publicNetworkAccess:
          type: string
          description: 'This value can be set to ''enabled'' to avoid breaking changes on existing

            customer resources and templates. If set to ''disabled'', traffic over public

            interface is not allowed, and private endpoint connections would be the

            exclusive access method.'
        customerStorageAccountArmId:
          type: string
          description: 'The ARM id of the storage account used for interactions when public access is

            disabled.'
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The status of the last operation.
    AzureResourceProperties:
      type: object
      description: Common properties for all azure tracked and proxy resources.
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The status of the last operation.
    ProjectStatus:
      type: string
      description: Project Status.
      enum:
      - Active
      - Inactive
      x-ms-enum:
        name: ProjectStatus
        modelAsString: true
        values:
        - name: Active
          value: Active
          description: Active Status.
        - name: Inactive
          value: Inactive
          description: Inactive Status.
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.