Skip to content

Commit 757c3df

Browse files
gavinbarronCopilot
andcommitted
Document -LoginHint parameter in Connect-MgGraph help
Add the missing -LoginHint parameter block to the Connect-MgGraph markdown docs and generated MAML help (syntax + parameter list), which the earlier docs regeneration omitted because the module DLL predated the new parameter. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 04338979-a6b1-4abe-9ffe-42eb16b07442
1 parent c7c9534 commit 757c3df

2 files changed

Lines changed: 41 additions & 2 deletions

File tree

src/Authentication/Authentication/Microsoft.Graph.Authentication.dll-Help.xml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,18 @@ Canary https://login.microsoftonline.com https://microsoftgraph.com User-de
484484
</dev:type>
485485
<dev:defaultValue>None</dev:defaultValue>
486486
</command:parameter>
487+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
488+
<maml:name>LoginHint</maml:name>
489+
<maml:description>
490+
<maml:para>The login hint (typically a username or email) used to pre-populate the account field during interactive browser authentication.</maml:para>
491+
</maml:description>
492+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
493+
<dev:type>
494+
<maml:name>String</maml:name>
495+
<maml:uri />
496+
</dev:type>
497+
<dev:defaultValue>None</dev:defaultValue>
498+
</command:parameter>
487499
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
488500
<maml:name>NoWelcome</maml:name>
489501
<maml:description>
@@ -921,6 +933,18 @@ Canary https://login.microsoftonline.com https://microsoftgraph.com User-de
921933
</dev:type>
922934
<dev:defaultValue>False</dev:defaultValue>
923935
</command:parameter>
936+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
937+
<maml:name>LoginHint</maml:name>
938+
<maml:description>
939+
<maml:para>The login hint (typically a username or email) used to pre-populate the account field during interactive browser authentication.</maml:para>
940+
</maml:description>
941+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
942+
<dev:type>
943+
<maml:name>String</maml:name>
944+
<maml:uri />
945+
</dev:type>
946+
<dev:defaultValue>None</dev:defaultValue>
947+
</command:parameter>
924948
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
925949
<maml:name>NoWelcome</maml:name>
926950
<maml:description>

src/Authentication/docs/Connect-MgGraph.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Microsoft Graph PowerShell supports two types of authentication: delegated and a
1515
### UserParameterSet (Default)
1616
```
1717
Connect-MgGraph [[-Scopes] <String[]>] [[-ClientId] <String>] [-TenantId <String>]
18-
[-ContextScope <ContextScope>] [-Environment <String>] [-UseDeviceCode] [-ClientTimeout <Double>] [-NoWelcome]
19-
[-ProgressAction <ActionPreference>] [<CommonParameters>]
18+
[-ContextScope <ContextScope>] [-Environment <String>] [-UseDeviceCode] [-LoginHint <String>]
19+
[-ClientTimeout <Double>] [-NoWelcome] [-ProgressAction <ActionPreference>] [<CommonParameters>]
2020
```
2121

2222
### AppCertificateParameterSet
@@ -364,6 +364,21 @@ Accept pipeline input: False
364364
Accept wildcard characters: False
365365
```
366366
367+
### -LoginHint
368+
The login hint (typically a username or email) used to pre-populate the account field during interactive browser authentication.
369+
370+
```yaml
371+
Type: String
372+
Parameter Sets: UserParameterSet
373+
Aliases:
374+
375+
Required: False
376+
Position: Named
377+
Default value: None
378+
Accept pipeline input: False
379+
Accept wildcard characters: False
380+
```
381+
367382
### -NoWelcome
368383
Hides the welcome message.
369384

0 commit comments

Comments
 (0)