Projects - Create

Create or update project.
Create a project with specified name. If a project already exists, update it.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}?api-version=2018-02-02

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Azure Subscription Id in which project was created.

resourceGroupName
path True
  • string

Name of the Azure Resource Group that project is part of.

projectName
path True
  • string

Name of the Azure Migrate project.

api-version
query True
  • string

Standard request header. Used by service to identify API version used by client.

Request Header

Name Required Type Description
Accept-Language
  • string

Standard request header. Used by service to respond to client in appropriate language.

Request Body

Name Type Description
eTag
  • string

For optimistic concurrency control.

location
  • string

Azure location in which project is created.

properties.customerWorkspaceId
  • string

ARM ID of the Service Map workspace created by user.

properties.customerWorkspaceLocation
  • string

Location of the Service Map workspace created by user.

properties.provisioningState

Provisioning state of the project.

tags
  • object

Tags provided by Azure Tagging service.

Responses

Name Type Description
200 OK

OK. Existing project updated.

Headers

  • x-ms-request-id: string
201 Created

Created. New project was created.

Headers

  • x-ms-request-id: string
Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Projects_Create

Sample Request

PUT https://management.azure.com/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourcegroups/myResourceGroup/providers/Microsoft.Migrate/projects/project01?api-version=2018-02-02
{
  "properties": {
    "customerWorkspaceId": "url-to-customers-service-map",
    "customerWorkspaceLocation": "West Us"
  },
  "id": "/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/projects/project01",
  "name": "project01",
  "type": "Microsoft.Migrate/projects",
  "eTag": "\"b701c73a-0000-0000-0000-59c12ff00000\"",
  "location": "West Us",
  "tags": {}
}

Sample Response

{
  "properties": {
    "numberOfGroups": 2,
    "numberOfMachines": 5,
    "numberOfAssessments": 5,
    "createdTimestamp": "2018-02-02T13:11:30.8808917Z",
    "updatedTimestamp": "2018-02-02T13:11:30.8848966Z",
    "discoveryStatus": "NotStarted",
    "customerWorkspaceId": "url-to-customers-service-map",
    "customerWorkspaceLocation": "West Us",
    "lastDiscoveryTimestamp": "2018-02-02T13:11:30.8808917Z",
    "lastDiscoverySessionId": "2c213c69-e2d3-4c3e-b871-83e5f42f3299",
    "lastAssessmentTimestamp": "2018-02-02T13:11:30.8808917Z",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/projects/project01",
  "name": "project01",
  "type": "Microsoft.Migrate/projects",
  "eTag": "\"b701c73a-0000-0000-0000-59c12ff00000\"",
  "location": "West Us",
  "tags": {}
}
{
  "properties": {
    "numberOfGroups": 2,
    "numberOfMachines": 5,
    "numberOfAssessments": 5,
    "createdTimestamp": "2018-02-02T13:11:30.8808917Z",
    "updatedTimestamp": "2018-02-02T13:11:30.8848966Z",
    "discoveryStatus": "NotStarted",
    "customerWorkspaceId": "url-to-customers-service-map",
    "customerWorkspaceLocation": "West Us",
    "lastDiscoveryTimestamp": "2018-02-02T13:11:30.8808917Z",
    "lastDiscoverySessionId": "2c213c69-e2d3-4c3e-b871-83e5f42f3299",
    "lastAssessmentTimestamp": "2018-02-02T13:11:30.8808917Z",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/projects/project01",
  "name": "project01",
  "type": "Microsoft.Migrate/projects",
  "eTag": "\"b701c73a-0000-0000-0000-59c12ff00000\"",
  "location": "West Us",
  "tags": {}
}

Definitions

CloudError

An error response from the Azure Migrate service.

CloudErrorBody

An error response from the Azure Migrate service.

DiscoveryStatus

Reports whether project is under discovery.

Project

Azure Migrate Project.

ProvisioningState

Provisioning state of the project.

CloudError

An error response from the Azure Migrate service.

Name Type Description
error

An error response from the Azure Migrate service.

CloudErrorBody

An error response from the Azure Migrate service.

Name Type Description
code
  • string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

A list of additional details about the error.

message
  • string

A message describing the error, intended to be suitable for display in a user interface.

target
  • string

The target of the particular error. For example, the name of the property in error.

DiscoveryStatus

Reports whether project is under discovery.

Name Type Description
Completed
  • string
InProgress
  • string
NotStarted
  • string
Unknown
  • string

Project

Azure Migrate Project.

Name Type Description
eTag
  • string

For optimistic concurrency control.

id
  • string

Path reference to this project /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}

location
  • string

Azure location in which project is created.

name
  • string

Name of the project.

properties.createdTimestamp
  • string

Time when this project was created. Date-Time represented in ISO-8601 format.

properties.customerWorkspaceId
  • string

ARM ID of the Service Map workspace created by user.

properties.customerWorkspaceLocation
  • string

Location of the Service Map workspace created by user.

properties.discoveryStatus

Reports whether project is under discovery.

properties.lastAssessmentTimestamp
  • string

Time when last assessment was created. Date-Time represented in ISO-8601 format. This value will be null until assessment is created.

properties.lastDiscoverySessionId
  • string

Session id of the last discovery.

properties.lastDiscoveryTimestamp
  • string

Time when this project was created. Date-Time represented in ISO-8601 format. This value will be null until discovery is complete.

properties.numberOfAssessments
  • integer

Number of assessments created in the project.

properties.numberOfGroups
  • integer

Number of groups created in the project.

properties.numberOfMachines
  • integer

Number of machines in the project.

properties.provisioningState

Provisioning state of the project.

properties.updatedTimestamp
  • string

Time when this project was last updated. Date-Time represented in ISO-8601 format.

tags
  • object

Tags provided by Azure Tagging service.

type
  • string

Type of the object = [Microsoft.Migrate/projects].

ProvisioningState

Provisioning state of the project.

Name Type Description
Accepted
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Moving
  • string
Succeeded
  • string