Projects - Get

Service:

Azure Migrate

API Version:

2019-10-01

Get the specified project.
Get the project with the specified name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}?api-version=2019-10-01

URI Parameters

Name	In	Required	Type	Description
projectName	path	True	string	Name of the Azure Migrate project.
resourceGroupName	path	True	string	Name of the Azure Resource Group that project is part of.
subscriptionId	path	True	string	Azure Subscription Id in which project was created.
api-version	query	True	string	Standard request header. Used by service to identify API version used by client.

Responses

Name	Type	Description
200 OK	Project	OK. Headers x-ms-request-id: string
Other Status Codes	CloudError	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_Get

Sample Request

HTTP

GET https://management.azure.com/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourcegroups/abgoyal-westEurope/providers/Microsoft.Migrate/assessmentProjects/abgoyalWEselfhostb72bproject?api-version=2019-10-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourceGroups/abgoyal-westEurope/providers/Microsoft.Migrate/assessmentprojects/abgoyalWEselfhostb72bproject",
  "name": "abgoyalWEselfhostb72bproject",
  "type": "Microsoft.Migrate/assessmentprojects",
  "eTag": "\"0600c777-0000-0d00-0000-5cdaa4170000\"",
  "location": "westeurope",
  "properties": {
    "numberOfGroups": 2,
    "numberOfMachines": 28,
    "numberOfAssessments": 3,
    "lastAssessmentTimestamp": "2019-05-14T11:18:47.7893715Z",
    "createdTimestamp": "2019-05-09T08:28:53.3305058Z",
    "updatedTimestamp": "2019-05-09T10:11:16.0228967Z",
    "serviceEndpoint": "https://asmsrvprodwe.prod.migration.windowsazure.com/",
    "assessmentSolutionId": "/subscriptions/6393a73f-8d55-47ef-b6dd-179b3e0c7910/resourcegroups/abgoyal-westeurope/providers/microsoft.migrate/migrateprojects/abgoyalweselfhost/Solutions/Servers-Assessment-ServerAssessment",
    "projectStatus": "Active",
    "customerWorkspaceId": null,
    "customerWorkspaceLocation": null,
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
CloudError	An error response from the Azure Migrate service.
CloudErrorBody	An error response from the Azure Migrate service.
PrivateEndpointConnection	A private endpoint connection for a project.
PrivateEndpointConnectionProperties	Private endpoint connection properties.
PrivateLinkServiceConnectionState	State of a private endpoint connection.
Project	Azure Migrate Project.
ProjectProperties	Properties of a project.
ProjectStatus	Assessment project status.
ProvisioningState	Provisioning state of the project.
ResourceId	ARM id for a resource.

CloudError

An error response from the Azure Migrate service.

Name	Type	Description
error	CloudErrorBody	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	CloudErrorBody[]	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.

PrivateEndpointConnection

A private endpoint connection for a project.

Name	Type	Description
eTag	string	For optimistic concurrency control.
id	string	Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}
name	string	Name of the private endpoint endpoint connection.
properties	PrivateEndpointConnectionProperties	Properties of the private endpoint endpoint connection.
type	string	Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections].

PrivateEndpointConnectionProperties

Private endpoint connection properties.

Name	Type	Description
privateEndpoint	ResourceId	ARM id for the private endpoint resource corresponding to the connection.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	State of the private endpoint connection.
provisioningState	enum: Accepted Failed InProgress Succeeded	Indicates whether there is an ongoing operation on the private endpoint.

PrivateLinkServiceConnectionState

State of a private endpoint connection.

Name	Type	Description
actionsRequired	string	Actions required on the private endpoint connection.
description	string	Description of the private endpoint connection.
status	enum: Approved Disconnected Pending Rejected	Connection status of the private endpoint connection.

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/assessmentProjects/{projectName}
location	string	Azure location in which project is created.
name	string	Name of the project.
properties	ProjectProperties	Properties of the project.
tags	object	Tags provided by Azure Tagging service.
type	string	Type of the object = [Microsoft.Migrate/assessmentProjects].

ProjectProperties

Properties of a project.

Name	Type	Description
assessmentSolutionId	string	Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects.
createdTimestamp	string	Time when this project was created. Date-Time represented in ISO-8601 format.
customerStorageAccountArmId	string	The ARM id of the storage account used for interactions when public access is disabled.
customerWorkspaceId	string	The ARM id of service map workspace created by customer.
customerWorkspaceLocation	string	Location of service map workspace created by customer.
lastAssessmentTimestamp	string	Time when last assessment was created. Date-Time represented in ISO-8601 format. This value will be null until assessment is created.
numberOfAssessments	integer	Number of assessments created in the project.
numberOfGroups	integer	Number of groups created in the project.
numberOfMachines	integer	Number of machines in the project.
privateEndpointConnections	PrivateEndpointConnection[]	The list of private endpoint connections to the project.
projectStatus	ProjectStatus	Assessment project status.
provisioningState	ProvisioningState	Provisioning state of the project.
publicNetworkAccess	string	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.
serviceEndpoint	string	Endpoint at which the collector agent can call agent REST API.
updatedTimestamp	string	Time when this project was last updated. Date-Time represented in ISO-8601 format.

ProjectStatus

Assessment project status.

Name	Type	Description
Active	string
Inactive	string

ProvisioningState

Provisioning state of the project.

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

ResourceId

ARM id for a resource.

Name	Type	Description
id	string