Skip to content

Commit 600c08b

Browse files
authored
Enhance Connect-SPOService with managed identity support
Added parameters for managed identity authentication to Connect-SPOService.
1 parent 4ef1f00 commit 600c08b

File tree

1 file changed

+82
-4
lines changed

1 file changed

+82
-4
lines changed

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md

Lines changed: 82 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,25 @@ Connects a SharePoint Administrator or SharePoint Embedded Administrator to the
2323
### AuthenticationCertificate
2424

2525
```
26-
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-ClientTag] <String>] [-Region <AADCrossTenantAuthenticationLocation>] [-AuthenticationUrl <String>] [-Certificate <X509Certificate2>] [-CertificatePath <String>] [-CertificateThumbprint <String>] [-CertificatePassword <SecureString>] -ClientId <String> -TenantId <String> [<CommonParameters>]
26+
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-ClientTag] <String>] [-Region <AADCrossTenantAuthenticationLocation>] [-AuthenticationUrl <String>] [-Certificate <X509Certificate2>] [-CertificatePath <String>] [-CertificateThumbprint <String>] [-CertificatePassword <SecureString>] -ClientId <String> -TenantId <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
2727
```
2828

2929
### AuthenticationLocation
3030

3131
```
32-
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] [-Region <AADCrossTenantAuthenticationLocation>] [[-ModernAuth] <Boolean>] [[-UseSystemBrowser] <Boolean>]
32+
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] [-Region <AADCrossTenantAuthenticationLocation>] [[-ModernAuth] <Boolean>] [-ProgressAction <ActionPreference>] [[-UseSystemBrowser] <Boolean>]
33+
```
34+
35+
### AuthenticationManagedIdentity
36+
37+
```
38+
Connect-SPOService -Url <UrlCmdletPipeBind> [-ClientTag <String>] [-ManagedIdentity] [-ManagedIdentityType <ManagedIdentityType>] [-ManagedIdentityClientId <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
3339
```
3440

3541
### AuthenticationUrl
3642

3743
```
38-
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] -AuthenticationUrl <String> [[-ModernAuth] <Boolean>] [[-UseSystemBrowser] <Boolean>] [<CommonParameters>]
44+
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] -AuthenticationUrl <String> [[-ModernAuth] <Boolean>] [[-UseSystemBrowser] <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
3945
```
4046

4147
## DESCRIPTION
@@ -284,6 +290,60 @@ Accept pipeline input: True (ByValue)
284290
Accept wildcard characters: False
285291
```
286292

293+
### -ManagedIdentity
294+
295+
> Applicable: SharePoint Online
296+
297+
Enables the use of managed identity instead of user or certificate‑based authentication
298+
299+
```yaml
300+
Type: SwitchParameter
301+
Parameter Sets: AuthenticationManagedIdentity
302+
Aliases:
303+
304+
Required: True
305+
Position: Named
306+
Default value: None
307+
Accept pipeline input: False
308+
Accept wildcard characters: False
309+
```
310+
311+
### -ManagedIdentityClientId
312+
313+
> Applicable: SharePoint Online
314+
315+
Specifies the client ID of a user‑assigned managed identity to use for authentication.
316+
317+
```yaml
318+
Type: String
319+
Parameter Sets: AuthenticationManagedIdentity
320+
Aliases:
321+
322+
Required: False
323+
Position: Named
324+
Default value: None
325+
Accept pipeline input: False
326+
Accept wildcard characters: False
327+
```
328+
329+
### -ManagedIdentityType
330+
331+
> Applicable: SharePoint Online
332+
333+
Specifies the type of managed identity to use when authenticating. If not specified, the default managed identity type is used.
334+
335+
```yaml
336+
Type: ManagedIdentityType
337+
Parameter Sets: AuthenticationManagedIdentity
338+
Aliases:
339+
340+
Required: False
341+
Position: Named
342+
Default value: None
343+
Accept pipeline input: False
344+
Accept wildcard characters: False
345+
```
346+
287347
### -ModernAuth
288348

289349
> Applicable: SharePoint Online
@@ -303,6 +363,24 @@ Accept pipeline input: False
303363
Accept wildcard characters: False
304364
```
305365

366+
### -ProgressAction
367+
368+
> Applicable: SharePoint Online
369+
370+
Specifies how progress information is displayed during command execution.
371+
372+
```yaml
373+
Type: ActionPreference
374+
Parameter Sets: (All)
375+
Aliases: proga
376+
377+
Required: False
378+
Position: Named
379+
Default value: None
380+
Accept pipeline input: False
381+
Accept wildcard characters: False
382+
```
383+
306384
### -Region
307385

308386
> Applicable: SharePoint Online
@@ -406,4 +484,4 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar
406484

407485
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
408486

409-
[Disconnect-SPOService](./Disconnect-SPOService.md)
487+
[Disconnect-SPOService](./Disconnect-SPOService.md)

0 commit comments

Comments
 (0)