Merge branch 'dev' into getmgdomain-typo

timayabi2020 · web-flow · commit 95df2cf7dc59 · 2023-07-04T18:50:55.000+03:00
diff --git a/README.md b/README.md
@@ -7,10 +7,10 @@
   Consume <a href="https://graph.microsoft.com">Microsoft Graph</a> resources directly from your PowerShell scripts
 </h4>
 
-<h3 align="center"><a href="https://learn.microsoft.com/powershell/microsoftgraph/overview">Documentation</a></h3>
+<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>
 
 <p align="center">
-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.
+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.
 </p>
 
 <p align="center">
@@ -44,7 +44,7 @@ Microsoft Graph PowerShell module is published on [PowerShell Gallery](https://w
 Install-Module Microsoft.Graph
 ```
 
-> Run `Install-Module` with AllowClobber and Force parameters if you run into command name conflicts when upgrading to older versions of the module:
+> 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:
 >
 > ```powershell
 > Install-Module Microsoft.Graph -AllowClobber -Force
@@ -122,10 +122,12 @@ The following breaking changes have been introduced between `v1.x` and `v2.x`:
 - Dropped profile support.
 - Dropped support for `-ForceRefresh` on `Connect-MgGraph`.
 - Renamed `beta` command names from `<Verb>-Mg<Noun>` to `<Verb>-MgBeta<Noun>`.
+- Renamed `DeviceManagement.Enrolment` module to `DeviceManagement.Enrollment`.
+- Moved directory role and entitlement management commands from `DeviceManagement.Enrollment` to `Identity.Governance` module.
 - Changed beta namespace from `Microsoft.Graph.PowerShell.Models.<Entity>` to `Microsoft.Graph.Beta.PowerShell.Models.<Entity>`.
 - Changed `-AccessToken` type on `Connect-MgGraph` from `String` to `SecureString`.
 
-See [v2 upgrade guide](https://github.com/microsoftgraph/msgraph-sdk-powershell/blob/features/2.0/docs/upgrade-to-v2.md) for more details.
+See the [v2 upgrade guide](./docs/upgrade-to-v2.md) for more details.
 
 ## Troubleshooting
 
@@ -135,13 +137,15 @@ When working with various operations in the Graph, you may encounter an error su
 
 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).
 
+See [Microsoft Graph API Permissions Reference](https://learn.microsoft.com/graph/permissions-reference) for more details.
+
 ### Common Errors
 
 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.
 
 ## Known Issues
 
-- 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.
+- 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.
 
 - 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:
   - Use `Disconnect-MgGraph` to sign out of the current session.
diff --git a/docs/authentication.md b/docs/authentication.md
@@ -5,20 +5,6 @@ The Microsoft Graph PowerShell module supports two types of authentication:
 - Delegated Access
 - App-only Access
 
-## Web Account Manager (WAM)
-WAM is a Windows 10+ component that acts as an authentication broker allowing the users of an app benefit from integration with accounts known to Windows, such as the account already signed into an active Windows session.
-
-Microsoft Graph PowerShell module supports WAM in the following scenraio:
-
-- To enable WAM on supported devices
-```PowerShell
-Set-MgGraphOption -EnableLoginByWAM $true
-```
-
-- To disable WAM on supported devices
-```PowerShell
-Set-MgGraphOption -EnableLoginByWAM $false
-```
 ## Delegated Access
 
 Delegated access uses a public client to get an access token and consume Microsoft Graph resources on behalf of the signed-in user.
@@ -125,3 +111,21 @@ When using `-AccessToken`, we won't have access to the refresh token and the cli
 ### Access Token Scopes (scp) Claims
 
 Before using the provided `-AccessToken` to get Microsoft Graph resources, customers should ensure that the access token has the necessary scopes/ permissions needed to access/modify a resource.
+
+## Web Account Manager (WAM)
+
+WAM is a Windows 10+ component that acts as an authentication broker allowing the users of an app benefit from integration with accounts known to Windows, such as the account already signed into an active Windows session.
+
+Microsoft Graph PowerShell module supports WAM in the following scenario:
+
+- To enable WAM on supported devices
+
+```PowerShell
+Set-MgGraphOption -EnableLoginByWAM $true
+```
+
+- To disable WAM on supported devices
+
+```PowerShell
+Set-MgGraphOption -EnableLoginByWAM $false
+```
diff --git a/docs/upgrade-to-v2.md b/docs/upgrade-to-v2.md
@@ -64,6 +64,14 @@ In v2, we've changed `-AccessToken` from `String` to `SecureString` type. This c
 
 We've dropped support for `-ForceRefresh` on `Connect-MgGraph` command. `-ForceRefresh` is no longer support by the auth token credentials used in v2. Customers should instead use `Disconnect-MgGraph` to sign out of current context then call `Connect-MgGraph` to get a new access token.
 
+### Renamed `DeviceManagement.Enrolment` module to `DeviceManagement.Enrollment`
+
+`DeviceManagement.Enrolment` module has been renamed to `DeviceManagement.Enrollment` to align with the API.
+
+### Directory Role and Entitlement Management Commands
+
+Directory role and entitlement management commands that were in `DeviceManagement.Enrollment` module have been moved to `Identity.Governance` to align with the [API reference](https://learn.microsoft.com/graph/api/resources/directoryrole?view=graph-rest-1.0).
+
 ## New Features and Improvements
 
 The following new features and improvements have been added to the module in v2.
@@ -124,9 +132,37 @@ Connect-MgGraph -EnvironmentVariable
 
 ### Service Modules
 
+#### Count Commands (`/$count`)
+
+We've added dedicated count commands in v2 for supported resources. In v2, you can now get a [count of users in your tenant](https://learn.microsoft.com/graph/api/user-list?view=graph-rest-1.0&tabs=http#example-3-get-only-a-count-of-users) using:
+
+``` powershell
+$UsersCount = Get-MgUserCount -ConsistencyLevel Eventual
+```
+
+See [advanced query capabilities on Azure AD objects](https://learn.microsoft.com/graph/aad-advanced-queries) for more details.
+
+#### OData Cast Support
+
+V2 adds OData cast commands via `*-Mg*As<CAST-Type>` syntax when supported by the API. With OData cast support, customers can now access properties on specialized types rather than going through AdditionalProperties for supported APIs. For example, one can use `Get-MgGroupMemberAsUser` to [list group members that are users](https://learn.microsoft.com/graph/api/group-list-members?view=graph-rest-1.0&tabs=http):
+
+```powershell
+$Users = Get-MgGroupMemberAsUser -GroupId "GROUP_ID"
+```
+
+> In the example above, the cast type can also be `ServicePrincipal`, `Application`, `Device`, `Group`, and more as supported by the API.
+
+#### Improved Service Error Reporting
+
+We've updated how service errors are written to the error stream to help with debugging API related errors. In v2, when a service error occurs, the SDK will now write message, HTTP status code, error code, request-id, date, and other useful headers to the error stream.
+
+![image](https://github.com/microsoftgraph/msgraph-sdk-powershell/assets/7061532/45ab9783-12ee-4666-b6ee-c29bfbff6827)
+
+See [Microsoft Graph API error response](https://learn.microsoft.com/graph/errors) for more details.
+
 #### HTTP/2 support
 
-v2 adds [HTTP/2](https://httpwg.org/specs/rfc7540.html) support for supported API endpoints. The module will gracefully fallback to HTTP/1.1 when HTTP/2 is not supported by the API. HTTP/2 improves performance by adding support for; multiplexing, header compression, and server push.
+V2 adds [HTTP/2](https://httpwg.org/specs/rfc7540.html) support for supported API endpoints. The module will gracefully fallback to HTTP/1.1 when HTTP/2 is not supported by the API. HTTP/2 improves performance by adding support for; multiplexing, header compression, and server push.
 
 #### Success status code range support
 
