Skip to content

Commit cef96b0

Browse files
committed
Add permission reference link to the readme.
1 parent ee5fc74 commit cef96b0

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
Consume <a href="https://graph.microsoft.com">Microsoft Graph</a> resources directly from your PowerShell scripts
88
</h4>
99

10-
<h3 align="center"><a href="https://learn.microsoft.com/powershell/microsoftgraph/overview">Documentation</a></h3>
10+
<h3 align="center"><a href="https://learn.microsoft.com/graph/overview">API Documentation</a> | <a href="https://learn.microsoft.com/powershell/microsoftgraph/overview">SDK Documentation</a></h3>
1111

1212
<p align="center">
13-
The Microsoft Graph PowerShell module consists of a collection of PowerShell modules that contain commands for calling Microsoft Graph API. The module acts as an API wrapper for the Microsoft Graph APIs, exposing the entire API set for use in PowerShell.
13+
The Microsoft Graph PowerShell SDK is made up of a set of modules that enable you to interact with the Microsoft Graph API using PowerShell commands. The modules consist of commands that act as wrappers for the API, allowing you to access all the features and functionality of the API through PowerShell.
1414
</p>
1515

1616
<p align="center">
@@ -44,7 +44,7 @@ Microsoft Graph PowerShell module is published on [PowerShell Gallery](https://w
4444
Install-Module Microsoft.Graph
4545
```
4646

47-
> Run `Install-Module` with AllowClobber and Force parameters if you run into command name conflicts when upgrading to older versions of the module:
47+
> Run `Install-Module` with `-AllowClobber` and `-Force` parameters if you run into command name conflicts when upgrading to older versions of the module. This may be the case when upgrading from v1.x to v2.x:
4848
>
4949
> ```powershell
5050
> Install-Module Microsoft.Graph -AllowClobber -Force
@@ -125,7 +125,7 @@ The following breaking changes have been introduced between `v1.x` and `v2.x`:
125125
- Changed beta namespace from `Microsoft.Graph.PowerShell.Models.<Entity>` to `Microsoft.Graph.Beta.PowerShell.Models.<Entity>`.
126126
- Changed `-AccessToken` type on `Connect-MgGraph` from `String` to `SecureString`.
127127

128-
See [v2 upgrade guide](https://github.com/microsoftgraph/msgraph-sdk-powershell/blob/features/2.0/docs/upgrade-to-v2.md) for more details.
128+
See the [v2 upgrade guide](./docs/upgrade-to-v2.md) for more details.
129129

130130
## Troubleshooting
131131

@@ -135,13 +135,15 @@ When working with various operations in the Graph, you may encounter an error su
135135

136136
If permission-related errors occur and the signed-in user/app has been granted the appropriate permissions to perform the operation, you can explicitly fetch a new access token by running `Disconnect-MgGraph`, then `Connect-MgGraph`. This will trigger a refresh of the access token in your cache. Microsoft Authentication Library (MSAL) will only refresh access tokens in your cache if they have expired (usually an hour).
137137

138+
See [Microsoft Graph API Permissions Reference](https://learn.microsoft.com/graph/permissions-reference) for more details.
139+
138140
### Common Errors
139141

140142
See our [troubleshooting guide](https://learn.microsoft.com/powershell/microsoftgraph/troubleshooting) for a detailed view of how to troubleshoot common errors when using Microsoft Graph.
141143

142144
## Known Issues
143145

144-
- Using `-Property {PropertyName}` parameter will not select the property as the output of the command. All commands return CLR objects, and customers should pipe the command outputs to `Format-Table` or `Select-Object` to return individual properties.
146+
- Using the `-Property {PropertyName}` parameter will not select the property as the output of the command. All commands return CLR objects, and customers should pipe the command outputs to `Format-Table` or `Select-Object` to return individual properties.
145147

146148
- Customers upgrading from previous versions of the SDK may encounter auth prompts on every command call. If this happens, one can use the following steps to reset their token cache:
147149
- Use `Disconnect-MgGraph` to sign out of the current session.

0 commit comments

Comments
 (0)