PSGSuite¶
Documentation¶
Check out PSGSuite.io for PSGSuite documentation, including initial setup help as well as function help!
Contributing¶
Interested in helping out with PSGSuite development? Please check out our Contribution Guidelines!
Building the module locally to test changes is as easy as running the build.ps1 file in the root of the repo. This will compile the module with your changes and import the newly compiled module at the end by default.
Want to run the Pester tests locally? Pass Test as the value to the Task script parameter like so:
.\build.ps1 -Task Test
Code of Conduct¶
Please adhere to our Code of Conduct when interacting with this repo.
License¶
Changelog¶
2.0.0 - Changes¶
New Functionality¶
- PowerShell Core support for cross-platform functionality
- P12 Keys (service accounts) and client_secrets.json (OAuth) are both now supported
- All Drive functions now support Team Drives
- Get-GSGmailMessage can now save message attachments to a local path
- File uploads to Drive are now supported (including recursive folder uploads!)
Breaking Changes in 2.0.0¶
Gmail Delegation Management Removed¶
~~The Gmail API does not yet support handling inbox delegation. The functionality addition has been pushed back again until Q3 of 2018. Once the Gmail API supports inbox delegation, those functions will be added.~~
Delegation functions have been re-added to PSGSuite as of v2.4.0! Update now to get all the goodness of v2 + delegation commands!
Functions Removed¶
Please note that not all functions were ported to PSGSuite 2.0.0 due to restrictions within the .NET SDK and deprecated API calls. Here is the list of functions no longer existing in PSGSuite as of 2.0.0:
Get-GSToken: no need for this as the keys are being consumed by Googles Auth SDK directly now, which makes Access/Refresh tokens non-existent for P12 Key service accounts and token management is handled automaticallyRevoke-GSToken: same here, no longer needed due to auth service changesStart-PSGSuiteConfigWizard: no longer supported as WPF is not compatible outside of Windows
Functions Aliased¶
All other functions are either intact or have an alias included to support backwards compatibility in scripts. Full list of aliases:
| Alias | Maps To |
|---|---|
| Add-GSDriveFilePermissions | Add-GSDrivePermission |
| Export-PSGSuiteConfiguration | Set-PSGSuiteConfig |
| Get-GSCalendarEventList | Get-GSCalendarEvent |
| Get-GSCalendarResourceList | Get-GSResourceList |
| Get-GSDataTransferApplicationList | Get-GSDataTransferApplication |
| Get-GSDriveFileInfo | Get-GSDriveFile |
| Get-GSDriveFilePermissionsList | Get-GSDrivePermission |
| Get-GSGmailDelegates | Get-GSGmailDelegate |
| Get-GSGmailFilterList | Get-GSGmailFilter |
| Get-GSGmailLabelList | Get-GSGmailLabel |
| Get-GSGmailMessageInfo | Get-GSGmailMessage |
| Get-GSGmailSendAsSettings | Get-GSGmailSendAsAlias |
| Get-GSGmailSignature | Get-GSGmailSendAsAlias |
| Get-GSGroupList | Get-GSGroup |
| Get-GSGroupMemberList | Get-GSGroupMember |
| Get-GSMobileDeviceList | Get-GSMobileDevice |
| Get-GSOrganizationalUnitList | Get-GSOrganizationalUnit |
| Get-GSOrgUnit | Get-GSOrganizationalUnit |
| Get-GSOrgUnitList | Get-GSOrganizationalUnit |
| Get-GSOU | Get-GSOrganizationalUnit |
| Get-GSResourceList | Get-GSResource |
| Get-GSShortURLInfo | Get-GSShortURL |
| Get-GSTeamDrive | Get-GSDrive |
| Get-GSTeamDrivesList | Get-GSDrive |
| Get-GSUserASPList | Get-GSUserASP |
| Get-GSUserLicenseInfo | Get-GSUserLicense |
| Get-GSUserLicenseList | Get-GSUserLicense |
| Get-GSUserList | Get-GSUser |
| Get-GSUserSchemaInfo | Get-GSUserSchema |
| Get-GSUserSchemaList | Get-GSUserSchema |
| Get-GSUserTokenList | Get-GSUserToken |
| Import-PSGSuiteConfiguration | Get-PSGSuiteConfig |
| Move-GSGmailMessageToTrash | Remove-GSGmailMessage |
| New-GSCalendarResource | New-GSResource |
| Remove-GSGmailMessageFromTrash | Restore-GSGmailMessage |
| Set-PSGSuiteDefaultDomain | Switch-PSGSuiteConfig |
| Switch-PSGSuiteDomain | Switch-PSGSuiteConfig |
| Update-GSCalendarResource | Update-GSResource |
| Update-GSGmailSendAsSettings | Update-GSGmailSendAsAlias |
| Update-GSSheetValue | Export-GSSheet |
Most recent changes¶
2.34.0 - 2019-11-02¶
- Issue #245 + PR #246 - Thank you, @devblackops!
- Added: Optional
-CreateMeetEventswitch parameter toNew-GSCalendarEventto create a Google Meet conference and attach it to the calendar event.
- Added: Optional