Merge pull request #11 from tony-li-avepoint/main

Add Get-FlyMigrationProject
AvePoint · Oct 13, 2023 · 2c85a0b · 2c85a0b
2 parents 04f4035 + d9028df
commit 2c85a0b
Show file tree

Hide file tree

Showing 5 changed files with 95 additions and 3 deletions.
diff --git a/powershell/docs/FlyApi.md b/powershell/docs/FlyApi.md
@@ -5,6 +5,7 @@ Method | Description
 [**Connect-Fly**](FlyConnectApi.md#connect-fly) | Connect to Fly Public API with Client Credentials.
 [**Disconnect-Fly**](FlyConnectApi.md#disconnect-fly) | Disconnect from Fly Public API.
 [**New-FlyMigrationProject**](FlyProjectApi.md#new-flymigrationproject) | Create a new migration project.
+[**Get-FlyMigrationProject**](FlyProjectApi.md#get-flymigrationproject) | Get a migration project by name.
 [**Import-FlyMigrationProjects**](FlyProjectApi.md#import-flymigrationprojects) | Import migration projects from csv file.
 [**Export-FlyErrorReport**](FlyProjectApi.md#export-flyerrorreport) | Generate error report for the specified.projects.
 [**Import-FlyExchangeMappings**](FlyExchangeApi.md#import-flyexchangemappings) | Add migration mappings into the specified Exchange project.

diff --git a/powershell/docs/FlyProjectApi.md b/powershell/docs/FlyProjectApi.md
@@ -3,6 +3,7 @@
 Method | Description
 ------------- | -------------
 [**New-FlyMigrationProject**](FlyProjectApi.md#new-flymigrationproject) | Create a new migration project.
+[**Get-FlyMigrationProject**](FlyProjectApi.md#get-flymigrationproject) | Get a migration project by name or platform.
 [**Import-FlyMigrationProjects**](FlyProjectApi.md#import-flymigrationprojects) | Import migration projects from csv file.
 [**Export-FlyErrorReport**](FlyProjectApi.md#export-flyerrorreport) | Generate error report for the specified.projects.
 
@@ -27,6 +28,10 @@ Name | Type | Description  | Notes
  **Policy** | **String**| Specify the name of policy which applied to the project. 
  **Tags** | **String[]**| Specify a list of tags to the project, optional if no tags for the project. | [optional]
 
+### Return type
+
+[**ProjectModel**](ProjectModel.md) (PSCustomObject)
+
 ### Example
 ```powershell
 $Name = "ProjectName" 
@@ -39,6 +44,31 @@ New-FlyMigrationProject -Name $Name -SourceConnection $SourceConnection -Destina
 ```
 [[Back to top]](#) [[Back to API list]](FlyApi.md#documentation-for-cmdlets) [[Back to README]](../README.md)
 
+<a name="Get-FlyMigrationProject"></a>
+# **Get-FlyMigrationProject**
+> ProjectModel Get-FlyMigrationProject<br>
+> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[-Name] <String><br>
+
+Get a migration project by name and platform.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **Name** | **String**| Specify the name of the project. 
+
+### Return type
+
+[**ProjectSummaryModel**](ProjectSummaryModel.md) (PSCustomObject)
+
+### Example
+```powershell
+$Name = "ProjectName" 
+
+Get-FlyMigrationProject -Name $Name
+```
+[[Back to top]](#) [[Back to API list]](FlyApi.md#documentation-for-cmdlets) [[Back to README]](../README.md)
+
 <a name="Import-FlyMigrationProjects"></a>
 
 # **Import-FlyMigrationProjects**
@@ -84,9 +114,6 @@ Name | Type | Description  | Notes
 
 ### Example
 ```powershell
-# Connect to Fly Public API first.
-Connect-Fly
-
 $Projects = @("ProjectName1","ProjectName2") 
 $OutFolder = "Report_Folder_Path" 
 $FileType = "Excel" 

diff --git a/powershell/docs/PlatformType.md b/powershell/docs/PlatformType.md
@@ -0,0 +1,20 @@
+# PlatformType
+```powershell
+enum PlatformType {
+    # enum value: "0"
+    Exchange
+    # enum value: "1"
+    Teams
+    # enum value: "2"
+    SharePoint
+    # enum value: "3"
+    OneDrive
+    # enum value: "4"
+    M365Group
+    # enum value: "5"
+    TeamChat
+}
+```
+
+
+[[Back to API list]](FlyApi.md#documentation-for-cmdlets) [[Back to README]](../README.md)
diff --git a/powershell/docs/ProjectModel.md b/powershell/docs/ProjectModel.md
@@ -0,0 +1,19 @@
+# ProjectModel
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Name** | **String** | Specify the name of project | 
+**SourcePlatform** | [**PlatformType**](PlatformType.md) | Specify the platform type of source connection | 
+**SourceConnectionId** | **String** | Specify the GUID of source connection | 
+**DestinationPlatform** | [**PlatformType**](PlatformType.md) | Specify the platform type of destination connection | 
+**DestinationConnectionId** | **String** | Specify the GUID of destination connection | 
+**PolicyId** | **String** | Specify the GUID of policy which applied to the project | 
+**TagIds** | **String[]** | Specify a list of tag ids to the project | 
+**CreateTime** | **DateTime** | The creation time of the project | 
+**CreateBy** | **String** | The user who create this project | 
+**LastModifyTime** | **DateTime** | The last modified time of the project | 
+**LastModifyBy** | **String** | The user who last modified the project | 
+**Id** | **String** | The GUID of the project | 
+
+[[Back to API list]](FlyApi.md#documentation-for-cmdlets) [[Back to README]](../README.md)
diff --git a/powershell/docs/ProjectSummaryModel.md b/powershell/docs/ProjectSummaryModel.md
@@ -0,0 +1,25 @@
+# ProjectSummaryModel
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**SourcePlatform** | [**PlatformType**](PlatformType.md) | The platform type of source connection of the project | 
+**DestinationPlatform** | [**PlatformType**](PlatformType.md) | The platform type of destination connection of the project | 
+**PolicyName** | **String** | The display name of policy which applied to the project | 
+**TagNames** | **String** | The tag names of the project, concatenate multiple values using semicolons | 
+**MappingTotalCount** | **Int32** | The total count of all mappings in the project | 
+**MappingNotMigratedCount** | **Int32** | The count of new mappings in the project | 
+**MappingInProgressCount** | **Int32** | The count of mappings which migration job is inprogress in the project | 
+**MappingStoppedCount** | **Int32** | The count of mappings which migration job is stopped in the project | 
+**MappingCompletedCount** | **Int32** | The count of mappings which migration job is finished in the project | 
+**MappingCompletedWithExceptionCount** | **Int32** | The count of mappings which migration job is exception in the project | 
+**MappingFailedCount** | **Int32** | The count of mappings which migration job is failed in the project | 
+**Name** | **String** | The name of the project | 
+**Description** | **String** | The description of the project | 
+**CreateTime** | **DateTime** | The creation time of the project | 
+**CreateBy** | **String** | The user who create this project | 
+**LastModifyTime** | **DateTime** | The last modified time of the project | 
+**LastModifyBy** | **String** | The user who last modified the project | 
+**Id** | **String** | The GUID of the project | 
+
+[[Back to API list]](FlyApi.md#documentation-for-cmdlets) [[Back to README]](../README.md)