Skip to content

Commit d19487f

Browse files
committed
Ready to !deploy
1 parent 42e945a commit d19487f

File tree

3 files changed

+37
-17
lines changed

3 files changed

+37
-17
lines changed

README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![Build status](https://ci.appveyor.com/api/projects/status/3vamqyscyp0yddof/branch/master?svg=true)](https://ci.appveyor.com/project/markekraus/psmsgraph/branch/master)
22
[![Documentation Status](https://readthedocs.org/projects/psmsgraph/badge/?version=latest)](http://psmsgraph.readthedocs.io/en/latest/?badge=latest)
3+
34
# PSMSGraph
45
This is a PowerShell module API wraper for the Microsoft Graph API.
56

@@ -16,9 +17,9 @@ This module is an API wrapper. It seeks to take the "foreign" concepts of REST a
1617
* In-memory and at-rest security of the Access Token, Refresh Token, and Client Secret. These are all stored in memory as secure strings and are only made plain-text on demand when needed. When exported to disk, they are done so with CLI XML which maintains the secure string.
1718
* Extensible type (Mark's "Poor Man's Classes") system allow for piping between functions similar to Active Directory or Exchange cmdlets
1819
* Easy OAuth authorization process with a WinForms authentication popup
19-
* No "mystery DLL's" required. The entire OAuth authorization, token request and token refresh process is written in pure PowerShell
20+
* No "mystery DLL's" required. The entire OAuth authorization, token request, and token refresh process is written in pure PowerShell
2021
* Export and Import access tokens between sessions allowing you to authorize an application once and reuse the token until the refresh expires from lack of use or is revoked. Great for automation!
21-
* No hassle Token Refreshing!! Calls to ```Invoke-GraphRequest``` automatically track the renewal needs for your Access Tokens and will automatically refresh them when needed.
22+
* No hassle Token Refreshing!! Calls to ```Invoke-GraphRequest``` (and all the functions that utalize it) automatically track the renewal needs for your Access Tokens and will automatically refresh them when needed.
2223

2324
## Installation
2425
PSMSGraph is available on the [PowerShell Gallery](https://www.powershellgallery.com/packages/psmsgraph/).
@@ -32,6 +33,10 @@ To install:
3233
Install-Module -Name PSMSgraph
3334
```
3435

36+
## Documentaion
37+
38+
Documentation Site: [psmsgraph.readthedocs.io](https://psmsgraph.readthedocs.io/)
39+
3540
## Quickstart
3641

3742
### Create an Azure AD Application
@@ -40,12 +45,12 @@ Install-Module -Name PSMSgraph
4045
3. Generate a new password for your app
4146
4. Give the app the proper scope permissions
4247
5. Set an arbitrary Redirect URI (e.g. ```https://localhost/```)
43-
5. Note your Redirect URI, Application ID, and the password that was generated. The Application ID is your "Client ID" and the password is your "Client Secret". These are not your O365/Azure username and password.
48+
5. Note your Redirect URI, Application ID, and the password that was generated. The Application ID is your "Client ID" and the password is your "Client Secret". These are not your O365/Azure username and password.
4449

4550
### Authorize the app and export your Access Token
4651
```powershell
47-
Import-Module -name PSMSGraph
48-
#In the credential prompt, provide your applications Client ID as the username and Client Secret as the password
52+
Import-Module -name 'PSMSGraph'
53+
#In the credential prompt, provide your application's Client ID as the username and Client Secret as the password
4954
$ClientCredential = Get-Credential
5055
$GraphAppParams = @{
5156
Name = 'My Graph Application!'
@@ -67,7 +72,7 @@ $GraphAccessToken | Export-GraphOAuthAccessToken -Path 'c:\MyGraphApp\AccessToke
6772

6873
### Build a script to pull in all Azure AD users
6974
```powershell
70-
Import-Module PSMSGraph
75+
Import-Module -name 'PSMSGraph'
7176
$GraphAccessToken = Import-GraphOAuthAccessToken -Path 'c:\MyGraphApp\AccessToken.XML'
7277
$GraphAccessToken | Update-GraphOAuthAccessToken -Force
7378
@@ -78,3 +83,9 @@ $AADUsers |
7883
7984
$GraphAccessToken | Export-GraphOAuthAccessToken -Path 'c:\MyGraphApp\AccessToken.XML'
8085
```
86+
87+
## Release Notes
88+
[https://github.com/markekraus/PSMSGraph/blob/develop/RELEASE.md](https://github.com/markekraus/PSMSGraph/blob/develop/RELEASE.md)
89+
90+
## ChangeLog
91+
[https://github.com/markekraus/PSMSGraph/blob/develop/docs/ChangeLog.md](https://github.com/markekraus/PSMSGraph/blob/develop/docs/ChangeLog.md)

RELEASE.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Version 1.0.24.17 (2017-03-05)
21
## Functions
2+
33
### All
44
* Added HelpUri and .LINK's to Comment based Help
55

@@ -9,18 +9,20 @@
99
### Get-AADGroupMember
1010
* Made function singular instead of plural (was Get-AADGroupMembers)
1111
* Added Get-AADGroupMembers alias
12-
* Fixed all the millions of problems this rename caused
12+
* Fixed all the problems this rename caused and exposed with the build process and documentation
1313

1414
## Build Tools
15+
1516
### psake.ps1
1617
* Restructured psake.ps1
1718
- Init > UnitTests > Build > Test > BuildDocs > Deploy > Post Deploy
18-
* Added AST based Function and Alias module manifest population
19+
* Added AST based Function and Alias module manifest population (now typos in file names will not cause function export issues)
1920
* Added NestedModule Population
2021
* Added Release notes and change log auto processing and documentation
2122
* PostDeploy is now local build friendly
2223

2324
## Tests
25+
2426
### PSScriptAnalyzer.tests.Ps1
2527
* Moved out of Project.Tests.ps1
2628
* Re-wroded the tests so they display better in AppVeyor test logs
@@ -37,6 +39,7 @@
3739
* Added Unit test for New-GraphOauthAccessToken
3840

3941
## Project
42+
4043
### RELEASE.md
4144
* Added this to server as the current release notes
4245
* Integrates automatically with ChangeLog.md through build pipeline

docs/index.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[![Build status](https://ci.appveyor.com/api/projects/status/3vamqyscyp0yddof/branch/master?svg=true)](https://ci.appveyor.com/project/markekraus/psmsgraph/branch/master)
2-
[![Documentation Status](https://readthedocs.org/projects/psmsgraph/badge/?version=latest)](http://psmsgraph.readthedocs.io/en/latest/?badge=latest)
31
# PSMSGraph
42
This is a PowerShell module API wraper for the Microsoft Graph API.
53

4+
Project Site: [https://github.com/markekraus/PSMSGraph](https://github.com/markekraus/PSMSGraph)
5+
66
## What is Microsft Graph?
77

88
The [Microsoft Graph API](https://graph.microsoft.io/) is a REST API provided by Microsoft for integrating and managing Office 365 Exchange Online, OneDrive for Business, and Azure AD. It allows for application developers to integrate their apps with those Microsoft Services. Management of the environment is also possible but requires understanding of OAuth and REST.
@@ -16,9 +16,9 @@ This module is an API wrapper. It seeks to take the "foreign" concepts of REST a
1616
* In-memory and at-rest security of the Access Token, Refresh Token, and Client Secret. These are all stored in memory as secure strings and are only made plain-text on demand when needed. When exported to disk, they are done so with CLI XML which maintains the secure string.
1717
* Extensible type (Mark's "Poor Man's Classes") system allow for piping between functions similar to Active Directory or Exchange cmdlets
1818
* Easy OAuth authorization process with a WinForms authentication popup
19-
* No "mystery DLL's" required. The entire OAuth authorization, token request and token refresh process is written in pure PowerShell
19+
* No "mystery DLL's" required. The entire OAuth authorization, token request, and token refresh process is written in pure PowerShell
2020
* Export and Import access tokens between sessions allowing you to authorize an application once and reuse the token until the refresh expires from lack of use or is revoked. Great for automation!
21-
* No hassle Token Refreshing!! Calls to ```Invoke-GraphRequest``` automatically track the renewal needs for your Access Tokens and will automatically refresh them when needed.
21+
* No hassle Token Refreshing!! Calls to ```Invoke-GraphRequest``` (and all the functions that utalize it) automatically track the renewal needs for your Access Tokens and will automatically refresh them when needed.
2222

2323
## Installation
2424
PSMSGraph is available on the [PowerShell Gallery](https://www.powershellgallery.com/packages/psmsgraph/).
@@ -40,12 +40,12 @@ Install-Module -Name PSMSgraph
4040
3. Generate a new password for your app
4141
4. Give the app the proper scope permissions
4242
5. Set an arbitrary Redirect URI (e.g. ```https://localhost/```)
43-
5. Note your Redirect URI, Application ID, and the password that was generated. The Application ID is your "Client ID" and the password is your "Client Secret". These are not your O365/Azure username and password.
43+
5. Note your Redirect URI, Application ID, and the password that was generated. The Application ID is your "Client ID" and the password is your "Client Secret". These are not your O365/Azure username and password.
4444

4545
### Authorize the app and export your Access Token
4646
```powershell
47-
Import-Module -name PSMSGraph
48-
#In the credential prompt, provide your applications Client ID as the username and Client Secret as the password
47+
Import-Module -name 'PSMSGraph'
48+
#In the credential prompt, provide your application's Client ID as the username and Client Secret as the password
4949
$ClientCredential = Get-Credential
5050
$GraphAppParams = @{
5151
Name = 'My Graph Application!'
@@ -67,7 +67,7 @@ $GraphAccessToken | Export-GraphOAuthAccessToken -Path 'c:\MyGraphApp\AccessToke
6767

6868
### Build a script to pull in all Azure AD users
6969
```powershell
70-
Import-Module PSMSGraph
70+
Import-Module -name 'PSMSGraph'
7171
$GraphAccessToken = Import-GraphOAuthAccessToken -Path 'c:\MyGraphApp\AccessToken.XML'
7272
$GraphAccessToken | Update-GraphOAuthAccessToken -Force
7373
@@ -78,3 +78,9 @@ $AADUsers |
7878
7979
$GraphAccessToken | Export-GraphOAuthAccessToken -Path 'c:\MyGraphApp\AccessToken.XML'
8080
```
81+
82+
## Release Notes
83+
[https://github.com/markekraus/PSMSGraph/blob/develop/RELEASE.md](https://github.com/markekraus/PSMSGraph/blob/develop/RELEASE.md)
84+
85+
## ChangeLog
86+
[https://github.com/markekraus/PSMSGraph/blob/develop/docs/ChangeLog.md](https://github.com/markekraus/PSMSGraph/blob/develop/docs/ChangeLog.md)

0 commit comments

Comments
 (0)