Skip to content

Commit 07b7682

Browse files
committed
Update SPO PowerShell cmdlet params
Update SPO PowerShell cmdlet params that have placeholder text with actual param descriptions. These descriptions were retrieved from the backend SPO code definition.
1 parent df5c998 commit 07b7682

29 files changed

+345
-184
lines changed

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Add-SPOOrgAssetsLibrary -LibraryUrl <String> [-ThumbnailUrl <String>] [-OrgAsset
2727

2828
## DESCRIPTION
2929

30-
The Add-SPOOrgAssetsLibrary cmdlet designates a library to be a central location for organization assets across the tenant. Once this cmdlet is run, assets stored within this library are available to sites across the tenant. The name publicly displayed for the library will be the organization's name. Note that it may take from a couple of hours to a day for changes to be reflected.
30+
The Add-SPOOrgAssetsLibrary cmdlet designates a library to be a central location for organization assets across the tenant. Once this cmdlet is run, assets stored within this library are available to sites across the tenant. The name publicly displayed for the library will be the organization's name. Note that it may take from a couple of hours to a day for changes to be reflected.
3131

3232
## EXAMPLES
3333

@@ -38,6 +38,7 @@ This example adds https://contoso.sharepoint.com/sites/branding/Assets as a desi
3838
```powershell
3939
Add-SPOOrgAssetsLibrary -LibraryURL https://contoso.sharepoint.com/sites/branding/Assets -ThumbnailURL https://contoso.sharepoint.com/sites/branding/Assets/contosologo.jpg
4040
```
41+
4142
### Example 2
4243

4344
This example adds https://contoso.sharepoint.com/sites/branding/Templates as a designated library for organization assets. Templates is the name of the SharePoint library added and will be the name publicly displayed for the library. The thumbnail publicly displayed for the library is contosologo.jpg, from that same library. OrgAssetType is the type of SharePoint library.
@@ -71,7 +72,10 @@ Accept wildcard characters: False
7172
```
7273
7374
### -CopilotSearchable
74-
{{ Fill CopilotSearchable Description }}
75+
76+
> Applicable: SharePoint Online
77+
78+
Specifies whether the library is made available to Microsoft 365 Copilot Search.
7579
7680
```yaml
7781
Type: System.Boolean
@@ -104,7 +108,10 @@ Accept wildcard characters: False
104108
```
105109
106110
### -NoDefaultOrigins
107-
{{ Fill NoDefaultOrigins Description }}
111+
112+
> Applicable: SharePoint Online
113+
114+
Specifies whether to provision default origins during activation of the CDN for organizational assets feature.
108115
109116
```yaml
110117
Type: System.Management.Automation.SwitchParameter
@@ -159,6 +166,7 @@ Accept wildcard characters: False
159166
```
160167
161168
### -Confirm
169+
162170
Prompts you for confirmation before running the cmdlet.
163171
164172
```yaml
@@ -174,6 +182,7 @@ Accept wildcard characters: False
174182
```
175183
176184
### -WhatIf
185+
177186
Shows what would happen if the cmdlet runs.
178187
The cmdlet is not run.
179188

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,10 @@ Accept wildcard characters: False
6666
```
6767
6868
### -DesignPackageId
69-
{{ Fill DesignPackageId Description }}
69+
70+
> Applicable: SharePoint Online
71+
72+
The ID of the design package associated with the site design.
7073
7174
```yaml
7275
Type: System.Guid
@@ -208,6 +211,7 @@ Accept wildcard characters: False
208211
```
209212
210213
### CommonParameters
214+
211215
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
212216
213217
## INPUTS

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenant.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,10 @@ This example returns the organization-level site collection properties such as S
4545
## PARAMETERS
4646

4747
### -ShowDetails
48-
{{ Fill ShowDetails Description }}
48+
49+
> Applicable: SharePoint Online
50+
51+
Whether to show the detailed properties for each setting.
4952

5053
```yaml
5154
Type: System.Management.Automation.SwitchParameter

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTheme.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ ms.reviewer:
1919
```
2020
Get-SPOTheme [[-Name] <String>] [<CommonParameters>]
2121
```
22+
2223
## DESCRIPTION
2324

2425
The **Get-SPOTheme** cmdlet returns the settings for a named existing theme, or for all uploaded themes if no name is provided.
@@ -78,7 +79,10 @@ Get-SPOTheme
7879
## PARAMETERS
7980

8081
### -Name
81-
{{ Fill Name Description }}
82+
83+
> Applicable: SharePoint Online
84+
85+
The name of the theme.
8286

8387
```yaml
8488
Type: System.String
@@ -93,6 +97,7 @@ Accept wildcard characters: False
9397
```
9498
9599
### CommonParameters
100+
96101
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
97102
98103
## INPUTS

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@ Creates a new migration job in the target site collection.
2121
## SYNTAX
2222

2323
### ImplicitSourceParameterSet
24+
2425
```
2526
Invoke-SPOMigrationEncryptUploadSubmit -MigrationSourceLocations <MigrationPackageLocation>
2627
-Credentials <CredentialCmdletPipeBind> -TargetWebUrl <String> [-NoLogFile] [-ParallelUpload]
2728
[<CommonParameters>]
2829
```
2930

3031
### ExplicitSourceParameterSet
32+
3133
```
3234
Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath <String> -SourcePackagePath <String>
3335
-Credentials <CredentialCmdletPipeBind> -TargetWebUrl <String> [-NoLogFile] [-ParallelUpload]
@@ -127,7 +129,10 @@ Accept wildcard characters: False
127129
```
128130
129131
### -ParallelUpload
130-
{{ Fill ParallelUpload Description }}
132+
133+
> Applicable: SharePoint Online
134+
135+
Whether to enable parallel upload of files to Azure.
131136
132137
```yaml
133138
Type: System.Management.Automation.SwitchParameter

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,10 @@ Accept wildcard characters: False
8080
```
8181
8282
### -EnableAgreementsSolution
83-
{{ Fill EnableAgreementsSolution Description }}
83+
84+
> Applicable: SharePoint Online
85+
86+
Whether to enable the Agreements Solution feature in the new site.
8487
8588
```yaml
8689
Type: System.Management.Automation.SwitchParameter

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,15 @@ For more information, see [Controlling your data in Office 365 using Customer Ke
2020
## SYNTAX
2121

2222
### BYOK_MultipleParameters (Default)
23+
2324
```
2425
Register-SPODataEncryptionPolicy -PrimaryKeyVaultName <String> -PrimaryKeyName <String>
2526
-PrimaryKeyVersion <Guid> -SecondaryKeyVaultName <String> -SecondaryKeyName <String>
2627
-SecondaryKeyVersion <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]
2728
```
2829

2930
### BYOK_Uri
31+
3032
```
3133
Register-SPODataEncryptionPolicy -PrimaryKeyVaultUri <Uri> -SecondaryKeyVaultUri <Uri> [-WhatIf] [-Confirm]
3234
[<CommonParameters>]
@@ -44,6 +46,7 @@ For more information, see [Controlling your data in Office 365 using Customer Ke
4446
```powershell
4547
Register-SPODataEncryptionPolicy -PrimaryKeyVaultName 'PKVaultName1' -PrimaryKeyName 'PrimaryKey1' -PrimaryKeyVersion 'f635a23bd4a44b9996ff6aadd88d42ba' -SecondaryKeyVaultName 'SKVaultName1' -SecondaryKeyName 'SecondaryKey2' -SecondaryKeyVersion '2b3e8f1d754f438dacdec1f0945f251a'
4648
```
49+
4750
This example registers the DEP used with SharePoint Online and OneDrive for Business to start using the given primary key.
4851

4952
## PARAMETERS
@@ -85,7 +88,10 @@ Accept wildcard characters: False
8588
```
8689
8790
### -PrimaryKeyVaultUri
88-
{{ Fill PrimaryKeyVaultUri Description }}
91+
92+
> Applicable: SharePoint Online
93+
94+
The Uri of the primary key vault
8995
9096
```yaml
9197
Type: System.Uri
@@ -154,7 +160,10 @@ Accept wildcard characters: False
154160
```
155161
156162
### -SecondaryKeyVaultUri
157-
{{ Fill SecondaryKeyVaultUri Description }}
163+
164+
> Applicable: SharePoint Online
165+
166+
The Uri of the secondary key vault
158167
159168
```yaml
160169
Type: System.Uri
@@ -189,6 +198,7 @@ Accept wildcard characters: False
189198
### -Confirm
190199
191200
> Applicable: SharePoint Online
201+
192202
Prompts you for confirmation before running the cmdlet.
193203
194204
```yaml

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ ms.reviewer:
1313
# Remove-SPOContainer
1414

1515
## SYNOPSIS
16+
1617
Sends a Container to the Recycle Bin.
1718

1819
## SYNTAX
@@ -42,7 +43,10 @@ Example 1 places the Container with the `ContainerId` `423poi45-jikl-9bnm-b302-1
4243
## PARAMETERS
4344

4445
### -Force
45-
{{ Fill Force Description }}
46+
47+
> Applicable: SharePoint Online
48+
49+
Whether to remove the container without prompting for confirmation.
4650

4751
```yaml
4852
Type: System.Management.Automation.SwitchParameter
@@ -75,6 +79,7 @@ Accept wildcard characters: False
7579
```
7680

7781
### -Confirm
82+
7883
Prompts you for confirmation before running the cmdlet.
7984

8085
```yaml
@@ -90,6 +95,7 @@ Accept wildcard characters: False
9095
```
9196

9297
### -WhatIf
98+
9399
Shows what would happen if the cmdlet runs.
94100
The cmdlet is not run.
95101

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ ms.reviewer:
1313
# Remove-SPOContainerType
1414

1515
## SYNOPSIS
16+
1617
This cmdlet removes the container type specified from the tenant.
1718

1819
## SYNTAX
@@ -34,6 +35,7 @@ You must be a SharePoint Embedded Administrator to run this cmdlet.
3435
```powershell
3536
Remove-SPOContainerTypeId -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604a8
3637
```
38+
3739
In Example 1, the cmdlet asks for a confirmation on the remove action and on confirmation, deletes the trial container type.
3840

3941
Example 1 places the container with the given ID into the recycle bin. The container will be permanently deleted from the recycle bin after 93 days unless the deleted container is [restored](./Restore-SPODeletedContainer.md) before permanent deletion.
@@ -59,7 +61,10 @@ Accept wildcard characters: False
5961
```
6062
6163
### -Force
62-
{{ Fill Force Description }}
64+
65+
> Applicable: SharePoint Online
66+
67+
Whether to remove the container type without prompting for confirmation.
6368
6469
```yaml
6570
Type: System.Management.Automation.SwitchParameter
@@ -74,6 +79,7 @@ Accept wildcard characters: False
7479
```
7580
7681
### -Confirm
82+
7783
Prompts you for confirmation before running the cmdlet.
7884
7985
```yaml
@@ -89,6 +95,7 @@ Accept wildcard characters: False
8995
```
9096
9197
### -WhatIf
98+
9299
Shows what would happen if the cmdlet runs.
93100
The cmdlet is not run.
94101
@@ -105,6 +112,7 @@ Accept wildcard characters: False
105112
```
106113
107114
### CommonParameters
115+
108116
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
109117
110118
## INPUTS
@@ -126,4 +134,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
126134
[Set-SPOContainerType](./Set-SPOContainerType.md)
127135
128136
[Remove-SPOContainerType](./Get-SPOContainerType.md)
129-

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,10 @@ This example removes a deleted Container with the `ContainerId` `b66f5b2e-4cbd-4
4545
## PARAMETERS
4646

4747
### -Force
48-
{{ Fill Force Description }}
48+
49+
> Applicable: SharePoint Online
50+
51+
Whether to remove the deleted container without prompting for confirmation.
4952

5053
```yaml
5154
Type: System.Management.Automation.SwitchParameter
@@ -78,6 +81,7 @@ Accept wildcard characters: False
7881
```
7982

8083
### -Confirm
84+
8185
Prompts you for confirmation before running the cmdlet.
8286

8387
```yaml
@@ -93,6 +97,7 @@ Accept wildcard characters: False
9397
```
9498

9599
### -WhatIf
100+
96101
Shows what would happen if the cmdlet runs.
97102
The cmdlet is not run.
98103

@@ -127,4 +132,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
127132
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
128133

129134
[Remove-SPOContainer](./Remove-SPOContainer.md)
130-

0 commit comments

Comments
 (0)