Skip to content

Commit 2c72b53

Browse files
authored
Update Connect-SPOService.md for clarity and examples
Removed unnecessary parameters from Connect-SPOService documentation and added examples for managed identity usage.
1 parent 600c08b commit 2c72b53

1 file changed

Lines changed: 21 additions & 23 deletions

File tree

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

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +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> [-ProgressAction <ActionPreference>] [<CommonParameters>]
26+
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-ClientTag] <String>] [-Region <AADCrossTenantAuthenticationLocation>] [-AuthenticationUrl <String>] [-Certificate <X509Certificate2>] [-CertificatePath <String>] [-CertificateThumbprint <String>] [-CertificatePassword <SecureString>] -ClientId <String> -TenantId <String> [<CommonParameters>]
2727
```
2828

2929
### AuthenticationLocation
3030

3131
```
32-
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] [-Region <AADCrossTenantAuthenticationLocation>] [[-ModernAuth] <Boolean>] [-ProgressAction <ActionPreference>] [[-UseSystemBrowser] <Boolean>]
32+
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] [-Region <AADCrossTenantAuthenticationLocation>] [[-ModernAuth] <Boolean>] [[-UseSystemBrowser] <Boolean>]
3333
```
3434

3535
### AuthenticationManagedIdentity
3636

3737
```
38-
Connect-SPOService -Url <UrlCmdletPipeBind> [-ClientTag <String>] [-ManagedIdentity] [-ManagedIdentityType <ManagedIdentityType>] [-ManagedIdentityClientId <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
38+
Connect-SPOService -Url <UrlCmdletPipeBind> [-ClientTag <String>] [-ManagedIdentity] [-ManagedIdentityType <ManagedIdentityType>] [-ManagedIdentityClientId <String>] [<CommonParameters>]
3939
```
4040

4141
### AuthenticationUrl
4242

4343
```
44-
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] -AuthenticationUrl <String> [[-ModernAuth] <Boolean>] [[-UseSystemBrowser] <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
44+
Connect-SPOService [-Url] <UrlCmdletPipeBind> [[-Credential] <CredentialCmdletPipeBind>] [[-ClientTag] <String>] -AuthenticationUrl <String> [[-ModernAuth] <Boolean>] [[-UseSystemBrowser] <Boolean>] [<CommonParameters>]
4545
```
4646

4747
## DESCRIPTION
@@ -132,6 +132,22 @@ Connect-SPOService -Url https://contoso-admin.sharepoint.com -ClientId 00000000-
132132

133133
This example connects to the SharePoint admin center by using an app identity and a certificate object.
134134

135+
### EXAMPLE 10
136+
137+
```powershell
138+
Connect-SPOService -Url https://contoso-admin.sharepoint.com -ManagedIdentity
139+
```
140+
141+
This example connects to the SharePoint admin center by using system assigned managed identity.
142+
143+
### EXAMPLE 11
144+
145+
```powershell
146+
Connect-SPOService -url https://contoso-admin.sharepoint.com -ManagedIdentity -ManagedIdentityType UserAssigned -ManagedIdentityClientId 00000000-0000-0000-0000-000000000000
147+
```
148+
149+
This example connects to the SharePoint admin center by using user assigned managed identity.
150+
135151
## PARAMETERS
136152

137153
### -AuthenticationUrl
@@ -294,7 +310,7 @@ Accept wildcard characters: False
294310

295311
> Applicable: SharePoint Online
296312

297-
Enables the use of managed identity instead of user or certificate‑based authentication
313+
Indicates that the connection uses a managed identity instead of user or certificate‑based authentication.
298314

299315
```yaml
300316
Type: SwitchParameter
@@ -363,24 +379,6 @@ Accept pipeline input: False
363379
Accept wildcard characters: False
364380
```
365381

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-
384382
### -Region
385383

386384
> Applicable: SharePoint Online

0 commit comments

Comments
 (0)