From 33c6d3a09fa57a80419d22f2f35858cb8fb334dc Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 15 Jul 2025 16:25:14 -0500 Subject: [PATCH] Move `Applicable:` tags to support PlatyPS --- .../Add-SPOContainerTypeBilling.md | 16 +- .../Add-SPOContentSecurityPolicy.md | 4 +- .../Add-SPOGeoAdministrator.md | 12 +- .../Add-SPOHubSiteAssociation.md | 8 +- .../Add-SPOHubToHubAssociation.md | 10 +- .../Add-SPOOrgAssetsLibrary.md | 12 +- .../Add-SPOSiteCollectionAppCatalog.md | 12 +- .../Add-SPOSiteDesign.md | 32 +- .../Add-SPOSiteDesignTask.md | 8 +- .../Add-SPOSiteScript.md | 12 +- .../Add-SPOTenantCdnOrigin.md | 16 +- .../Add-SPOTheme.md | 16 +- .../Add-SPOUser.md | 12 +- ...POTenantServicePrincipalPermissionGrant.md | 8 +- .../Connect-SPOService.md | 28 +- .../ConvertTo-SPOMigrationEncryptedPackage.md | 28 +- .../ConvertTo-SPOMigrationTargetedPackage.md | 60 ++- .../Copy-SPOPersonalSitePage.md | 16 +- .../Enable-SPOCommSite.md | 8 +- .../Export-SPOQueryLogs.md | 12 +- .../Export-SPOUserInfo.md | 12 +- .../Export-SPOUserProfile.md | 8 +- .../Get-FileSensitivityLabelInfo.md | 4 +- .../Get-SPOAppErrors.md | 12 +- .../Get-SPOAppInfo.md | 8 +- .../Get-SPOContainer.md | 20 +- .../Get-SPOContainerType.md | 4 +- .../Get-SPOContainerTypeConfiguration.md | 4 +- .../Get-SPOContentEventEmailAddresses.md | 4 +- .../Get-SPOCopilotAgentInsightsReport.md | 18 +- .../Get-SPOCrossGeoMoveReport.md | 24 +- .../Get-SPOCrossGeoMovedUsers.md | 4 +- .../Get-SPOCrossGeoUsers.md | 4 +- .../Get-SPOCrossTenantCompatibilityStatus.md | 4 +- .../Get-SPODeletedSite.md | 16 +- .../Get-SPOEnterpriseAppInsightsReport.md | 8 +- .../Get-SPOExternalUser.md | 24 +- .../Get-SPOGeoStorageQuota.md | 4 +- .../Get-SPOHubSite.md | 4 +- ...POListFileVersionBatchDeleteJobProgress.md | 4 +- ...tFileVersionExpirationReportJobProgress.md | 4 +- .../Get-SPOListVersionPolicy.md | 4 +- .../Get-SPOMalwareFile.md | 4 +- .../Get-SPOMalwareFileContent.md | 4 +- .../Get-SPOMigrationJobProgress.md | 32 +- .../Get-SPOMigrationJobStatus.md | 16 +- .../Get-SPOPersonalSitePageCopyProgress.md | 8 +- .../Get-SPORestrictedSiteCreation.md | 4 +- .../Get-SPOSite.md | 36 +- .../Get-SPOSiteCollectionAppCatalogs.md | 4 +- .../Get-SPOSiteContentMoveState.md | 4 +- .../Get-SPOSiteDataEncryptionPolicy.md | 4 +- .../Get-SPOSiteDesign.md | 4 +- .../Get-SPOSiteDesignRights.md | 4 +- .../Get-SPOSiteDesignTask.md | 8 +- ...POSiteFileVersionBatchDeleteJobProgress.md | 4 +- ...eFileVersionExpirationReportJobProgress.md | 4 +- .../Get-SPOSiteGroup.md | 12 +- .../Get-SPOSitePages.md | 4 +- .../Get-SPOSiteRenameState.md | 20 +- .../Get-SPOSiteScript.md | 4 +- .../Get-SPOSiteScriptFromList.md | 4 +- .../Get-SPOSiteScriptFromWeb.md | 28 +- .../Get-SPOSiteUserInvitations.md | 8 +- .../Get-SPOSiteVersionPolicyJobProgress.md | 4 +- .../Get-SPOStorageEntity.md | 8 +- ...t-SPOStructuralNavigationCacheSiteState.md | 4 +- ...et-SPOStructuralNavigationCacheWebState.md | 4 +- .../Get-SPOTenantCdnEnabled.md | 4 +- .../Get-SPOTenantCdnOrigins.md | 4 +- .../Get-SPOTenantCdnPolicies.md | 4 +- .../Get-SPOTenantLogEntry.md | 24 +- .../Get-SPOUnifiedGroup.md | 4 +- .../Get-SPOUnifiedGroupMoveState.md | 4 +- .../Get-SPOUser.md | 16 +- .../Get-SPOUserAndContentMoveState.md | 24 +- .../Get-SPOUserOneDriveLocation.md | 4 +- .../Get-SPOWebTemplate.md | 16 +- .../Grant-SPOHubSiteRights.md | 12 +- .../Grant-SPOSiteDesignRights.md | 12 +- .../Invoke-SPOMigrationEncryptUploadSubmit.md | 24 +- .../Invoke-SPOSiteDesign.md | 8 +- .../Invoke-SPOSiteSwap.md | 24 +- .../New-SPOAppBillingPolicy.md | 20 +- .../New-SPOContainerType.md | 24 +- .../New-SPOListFileVersionBatchDeleteJob.md | 4 +- ...w-SPOListFileVersionExpirationReportJob.md | 4 +- .../New-SPOMigrationPackage.md | 40 +- .../New-SPOPublicCdnOrigin.md | 12 +- .../New-SPOSdnProvider.md | 16 +- .../New-SPOSite.md | 40 +- .../New-SPOSiteFileVersionBatchDeleteJob.md | 4 +- ...w-SPOSiteFileVersionExpirationReportJob.md | 4 +- .../New-SPOSiteGroup.md | 12 +- .../New-SPOSiteSharingReportJob.md | 12 +- .../Register-SPODataEncryptionPolicy.md | 32 +- .../Register-SPOHubSite.md | 8 +- .../Remove-SPOAppBillingPolicy.md | 4 +- .../Remove-SPOContainer.md | 4 +- .../Remove-SPOContainerType.md | 4 +- .../Remove-SPOContentEventEmailAddresses.md | 4 +- .../Remove-SPOContentSecurityPolicy.md | 6 +- .../Remove-SPODeletedContainer.md | 4 +- .../Remove-SPODeletedSite.md | 16 +- .../Remove-SPOExternalUser.md | 12 +- .../Remove-SPOGeoAdministrator.md | 4 +- .../Remove-SPOHubSiteAssociation.md | 4 +- .../Remove-SPOHubToHubAssociation.md | 4 +- ...Remove-SPOListFileVersionBatchDeleteJob.md | 4 +- .../Remove-SPOMigrationJob.md | 16 +- ...e-SPOMultiGeoCompanyAllowedDataLocation.md | 12 +- .../Remove-SPOOrgAssetsLibrary.md | 8 +- .../Remove-SPOOrgNewsSite.md | 4 +- .../Remove-SPOPublicCdnOrigin.md | 12 +- .../Remove-SPOSdnProvider.md | 8 +- .../Remove-SPOSite.md | 16 +- .../Remove-SPOSiteCollectionAppCatalog.md | 4 +- .../Remove-SPOSiteCollectionAppCatalogById.md | 4 +- .../Remove-SPOSiteDesign.md | 4 +- .../Remove-SPOSiteDesignTask.md | 4 +- ...Remove-SPOSiteFileVersionBatchDeleteJob.md | 4 +- .../Remove-SPOSiteGroup.md | 8 +- .../Remove-SPOSiteScript.md | 4 +- .../Remove-SPOSiteUserInvitations.md | 12 +- .../Remove-SPOSiteVersionPolicyJob.md | 4 +- .../Remove-SPOStorageEntity.md | 8 +- .../Remove-SPOTenantCdnOrigin.md | 16 +- .../Remove-SPOUser.md | 12 +- .../Remove-SPOUserInfo.md | 8 +- .../Remove-SPOUserProfile.md | 4 +- .../Repair-SPOSite.md | 20 +- .../Request-SPOPersonalSite.md | 8 +- .../Request-SPOUpgradeEvaluationSite.md | 20 +- .../Restore-SPODataEncryptionPolicy.md | 24 +- .../Restore-SPODeletedContainer.md | 4 +- .../Restore-SPODeletedSite.md | 8 +- .../Revoke-SPOHubSiteRights.md | 8 +- .../Revoke-SPOSiteDesignRights.md | 8 +- .../Revoke-SPOUserSession.md | 12 +- .../Set-SPOApplication.md | 2 +- .../Set-SPOApplicationPermission.md | 16 +- .../Set-SPOBrowserIdleSignOut.md | 4 +- .../Set-SPOBuiltInSiteTemplateSettings.md | 8 +- .../Set-SPOContainer.md | 14 +- .../Set-SPOContainerTypeConfiguration.md | 8 +- .../Set-SPOContentEventEmailAddresses.md | 4 +- .../Set-SPOCopilotPromoOptInStatus.md | 4 +- .../Set-SPOCrossTenantRelationship.md | 12 +- .../Set-SPOGeoStorageQuota.md | 8 +- .../Set-SPOHubSite.md | 24 +- .../Set-SPOListVersionPolicy.md | 20 +- .../Set-SPOMigrationPackageAzureSource.md | 60 ++- ...t-SPOMultiGeoCompanyAllowedDataLocation.md | 16 +- .../Set-SPOMultiGeoExperience.md | 12 +- .../Set-SPOOrgAssetsLibrary.md | 12 +- .../Set-SPOOrgNewsSite.md | 4 +- .../Set-SPORestrictedSiteCreation.md | 16 +- .../Set-SPOSite.md | 300 +++++++++---- .../Set-SPOSiteArchiveState.md | 4 +- .../Set-SPOSiteDesign.md | 36 +- .../Set-SPOSiteGroup.md | 24 +- .../Set-SPOSiteOffice365Group.md | 24 +- .../Set-SPOSiteScript.md | 20 +- .../Set-SPOStorageEntity.md | 28 +- ...t-SPOStructuralNavigationCacheSiteState.md | 8 +- ...et-SPOStructuralNavigationCacheWebState.md | 8 +- .../Set-SPOTenant.md | 420 +++++++++++++----- .../Set-SPOTenantCdnEnabled.md | 20 +- .../Set-SPOTenantCdnPolicy.md | 12 +- ...OTenantContentTypeReplicationParameters.md | 8 +- .../Set-SPOTenantSyncClientRestriction.md | 20 +- ...-SPOTenantTaxonomyReplicationParameters.md | 8 +- .../Set-SPOUnifiedGroup.md | 8 +- .../Set-SPOUser.md | 12 +- .../Set-SPOWebTheme.md | 12 +- .../Start-SPOCopilotAgentInsightsReport.md | 8 +- .../Start-SPOEnterpriseAppInsightsReport.md | 8 +- ...art-SPORestrictedAccessForSitesInsights.md | 12 +- .../Start-SPOSiteContentMove.md | 28 +- ...SiteOpticalCharacterRecognitionBackfill.md | 4 +- .../Start-SPOSiteRename.md | 36 +- .../Start-SPOTenantRename.md | 16 +- .../Start-SPOUserAndContentMove.md | 24 +- .../Stop-SPOTenantRename.md | 8 +- .../Stop-SPOUserAndContentMove.md | 4 +- .../Submit-SPOMigrationJob.md | 32 +- .../Test-SPOSite.md | 12 +- ...Unlock-SPOSensitivityLabelEncryptedFile.md | 8 +- .../Unregister-SPOHubSite.md | 12 +- .../Update-UserType.md | 4 +- 190 files changed, 2224 insertions(+), 746 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md index 65994f62b..6f9a749f0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md @@ -47,13 +47,15 @@ Example 1 attaches the billing profile of Azure subscription ID "5a8a4d9f", reso ### -AzureSubscriptionId +> Applicable: SharePoint Online + This parameter describes the Azure subscription ID to which the container type needs to be associated. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ### -ContainerTypeId +> Applicable: SharePoint Online + This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -81,13 +85,15 @@ Accept wildcard characters: False ### -Region +> Applicable: SharePoint Online + This parameter describes the region to which the billing profile of the container type is associated with. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -98,13 +104,15 @@ Accept wildcard characters: False ### -ResourceGroup +> Applicable: SharePoint Online + This parameter describes the resource group to be used for the associated container type. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md index abe7727d6..1ea06080a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md @@ -35,13 +35,15 @@ In multi-geo environments, **Content Security Policy** configuration is unique t ### -Source +> Applicable: SharePoint Online + Source to be added to the **Content Security Policy** configuration. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md index 8d8f7975f..edc245699 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md @@ -53,13 +53,15 @@ Adds the user **admin\@contoso.onmicrosoft.com** as administrator to the SharePo ### -GroupAlias +> Applicable: SharePoint Online + Use this parameter to add a security group or a mail-enabled security group as a geo admin. (Distribution groups and Microsoft 365 Groups are not supported). ```yaml Type: System.String Parameter Sets: Group Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -70,13 +72,15 @@ Accept wildcard characters: False ### -ObjectId +> Applicable: SharePoint Online + Not all security groups have a group alias. If you want to add a security group that does not have an alias, run Get-MsolGroup to retrieve a list of groups, find your security group's ObjectID, and then use this parameter. For more information, see [Add or remove a geo administrator in Microsoft 365 Multi-Geo](/office365/enterprise/add-a-sharepoint-geo-admin). ```yaml Type: System.Guid Parameter Sets: ObjectId Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -87,13 +91,15 @@ Accept wildcard characters: False ### -UserPrincipalName +> Applicable: SharePoint Online + UserPrincipalName or UPN defined for the specific user on the SharePoint Online tenant. ```yaml Type: System.String Parameter Sets: User Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md index c0a40bbd7..c4714bfd1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md @@ -40,13 +40,15 @@ This example associates the research site with the marketing hub site. ### -HubSite +> Applicable: SharePoint Online + URL or Site ID of the hub site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + URL of the site to join to the hub site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubToHubAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubToHubAssociation.md index 01703065c..012ef2824 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubToHubAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubToHubAssociation.md @@ -41,13 +41,15 @@ This example associates the source hub site with the HubSiteId 7b6fd3a3-b029-4eb ### -Source +> Applicable: SharePoint Online + HubSiteId of the Source Hub site to be associated with the Target Hub Site. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Target +> Applicable: SharePoint Online + HubSiteId of the Target Hub to associate the source Hub to. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -85,7 +89,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -SPOHubToHubAssociation is just a placeholder and not yet ready for production. +SPOHubToHubAssociation is just a placeholder and not yet ready for production. ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md index 9f39fc2fc..e513a37e7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md @@ -50,6 +50,8 @@ Add-SPOOrgAssetsLibrary -LibraryURL https://contoso.sharepoint.com/sites/brandin ### -CdnType +> Applicable: SharePoint Online + Specifies the CDN type. The valid values are public or private. Note: The manually configured Private CDN is in the process of being deprecated. For more information, see [Use the Office 365 Content Delivery Network (CDN) with SharePoint Online](/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo). @@ -58,7 +60,7 @@ Note: The manually configured Private CDN is in the process of being deprecated. Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Accepted values: Public, Private Required: False @@ -85,13 +87,15 @@ Accept wildcard characters: False ### -LibraryUrl +> Applicable: SharePoint Online + Indicates the absolute URL of the library to be designated as a central location for organization assets. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -139,13 +143,15 @@ Accept wildcard characters: False ### -ThumbnailUrl +> Applicable: SharePoint Online + Indicates the URL of the background image used when the library is publicly displayed. If no thumbnail URL is indicated, the card will have a gray background. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md index 005637d7d..cb459c973 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md @@ -43,13 +43,15 @@ This example adds a SiteCollection app catalog to the specified site. ### -Site +> Applicable: SharePoint Online + Url of the site to add the app catalog to. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -60,6 +62,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -67,7 +71,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -78,6 +82,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -85,7 +91,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md index 4d8a8d11c..326e555f1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md @@ -49,13 +49,15 @@ Add-SPOSiteDesign ` ### -Description +> Applicable: SharePoint Online + The display description of the site design. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -80,13 +82,15 @@ Accept wildcard characters: False ### -IsDefault +> Applicable: SharePoint Online + A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](/sharepoint/dev/declarative-customization/customize-default-site-design). ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -96,13 +100,15 @@ Accept wildcard characters: False ### -PreviewImageAltText +> Applicable: SharePoint Online + The alt text description of the image for accessibility. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -112,13 +118,15 @@ Accept wildcard characters: False ### -PreviewImageUrl +> Applicable: SharePoint Online + The URL of a preview image. If none is specified, SharePoint uses a generic image. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -128,13 +136,15 @@ Accept wildcard characters: False ### -SiteScripts +> Applicable: SharePoint Online + An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -144,13 +154,15 @@ Accept wildcard characters: False ### -ThumbnailUrl +> Applicable: SharePoint Online + The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -160,13 +172,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + The display name of the site design. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -176,6 +190,8 @@ Accept wildcard characters: False ### -WebTemplate +> Applicable: SharePoint Online + Identifies which base template to add the design to. Use the value **64** for the Team site template, and the value **68** for the Communication site template. For more information, visit [SharePoint site design and site script overview](/sharepoint/dev/declarative-customization/site-design-overview). @@ -183,7 +199,7 @@ For more information, visit [SharePoint site design and site script overview](/s Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesignTask.md index 549e03d1d..6494a7e75 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesignTask.md @@ -47,13 +47,15 @@ Add-SPOSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl ### -SiteDesignId +> Applicable: SharePoint Online + The ID of the site design to apply. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -63,13 +65,15 @@ Accept wildcard characters: False ### -WebUrl +> Applicable: SharePoint Online + The URL of the site collection where the site design will be applied. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScript.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScript.md index 62a029798..5a8c37eec 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScript.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScript.md @@ -87,13 +87,15 @@ Add-SPOSiteDesign -Title "Communication Site with External Users and Guest Shari ### -Content +> Applicable: SharePoint Online + The JSON value that describes the script. For more information, see the [JSON reference](/sharepoint/dev/declarative-customization/site-design-json-schema). ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -103,13 +105,15 @@ Accept wildcard characters: False ### -Description +> Applicable: SharePoint Online + A description of the script. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -119,13 +123,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + The display name of the site design. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md index 864c84bde..708aa7b16 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md @@ -43,6 +43,8 @@ This example configures a public CDN on a site level. ### -CdnType +> Applicable: SharePoint Online + Specifies the CDN type. The valid values are: public or private. ```yaml @@ -50,7 +52,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private -Applicable: SharePoint Online + Required: True Position: Named @@ -61,6 +63,8 @@ Accept wildcard characters: False ### -OriginUrl +> Applicable: SharePoint Online + Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder within a document library. @@ -69,7 +73,7 @@ Relative-Relative path depends on the OriginScope. If the originScope is Tenant Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -80,13 +84,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -96,6 +102,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -103,7 +111,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTheme.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTheme.md index 8d1cb0705..9b8d3dcdb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTheme.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTheme.md @@ -82,13 +82,15 @@ Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false - ### -Identity +> Applicable: SharePoint Online + Specifies the name of the theme. This must uniquely identify the theme. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind Parameter Sets: (All) Aliases: Name -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -98,13 +100,15 @@ Accept wildcard characters: False ### -IsInverted +> Applicable: SharePoint Online + Specifies whether the theme is inverted, with a dark background and a light foreground. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: None -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -114,13 +118,15 @@ Accept wildcard characters: False ### -Overwrite +> Applicable: SharePoint Online + Overwrites a theme of the same name in case it exists. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: None -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -130,13 +136,15 @@ Accept wildcard characters: False ### -Palette +> Applicable: SharePoint Online + Specifies the palette of colors in the theme, as a dictionary of theme slot values. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePalettePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md index d3948d802..f985f064f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md @@ -50,13 +50,15 @@ Example 2 adds a user who has the e-mail address melissa.kerr@contoso.com to the ### -Group +> Applicable: SharePoint Online + Specifies the name of the SharePoint group to add the user or the security group to. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ### -LoginName +> Applicable: SharePoint Online + Specifies the login name of the user to add. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -84,13 +88,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site collection to which you want to add the user. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md index 1823f167c..3ff358fb8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md @@ -42,13 +42,15 @@ Adds a permission scope for the 'Microsoft Graph' resource with scope claim 'Mai ### -Resource +> Applicable: SharePoint Online + Resource of the permission request to add. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -59,13 +61,15 @@ Accept wildcard characters: False ### -Scope +> Applicable: SharePoint Online + Scope of the permission request to add. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md index 4eecc9c17..a4dfef227 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md @@ -102,13 +102,15 @@ Authenticates using the Microsoft Authentication Library (MSAL) and connects to ### -AuthenticationUrl +> Applicable: SharePoint Online + Location for Microsoft Entra Cross-Tenant Authentication service. Can be optionally used if non-default Cross-Tenant Authentication Service is used. ```yaml Type: System.String Parameter Sets: AuthenticationUrl Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -119,13 +121,15 @@ Accept wildcard characters: False ### -ClientTag +> Applicable: SharePoint Online + Permits appending a client tag to existing client tag. Used optionally in the CSOM http traffic to identify used script or solution. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -136,13 +140,15 @@ Accept wildcard characters: False ### -Credential +> Applicable: SharePoint Online + Specifies the credentials to use to connect. If no credentials are presented, a dialog will prompt for the credentials. The credentials must be those of a SharePoint Online administrator who can access the SharePoint Online Administration Center site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -153,6 +159,8 @@ Accept wildcard characters: False ### -ModernAuth +> Applicable: SharePoint Online + Ensures that SharePoint Online tenant administration cmdlets can connect to the service using modern TLS protocols. To use it you also need to provide the **AuthenticationUrl** parameter. @@ -161,7 +169,7 @@ To use it you also need to provide the **AuthenticationUrl** parameter. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -170,6 +178,8 @@ Accept wildcard characters: False ``` ### -Region +> Applicable: SharePoint Online + The valid values are: Default | ITAR | Germany | China The default value is "default". @@ -180,7 +190,7 @@ The default value is "default". Type: Microsoft.Online.SharePoint.PowerShell.AADCrossTenantAuthenticationLocation Parameter Sets: AuthenticationLocation Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -191,13 +201,15 @@ Accept wildcard characters: False ### -Url +> Applicable: SharePoint Online + Specifies the URL of the SharePoint Online Administration Center site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -208,13 +220,15 @@ Accept wildcard characters: False ### -UseSystemBrowser +> Applicable: SharePoint Online + Used to authenticate the user using the Microsoft Authentication Library (MSAL). ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md index 241ec316d..a64dd1399 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md @@ -58,6 +58,8 @@ Same as example1 but without log file and using an encryption type SHA384 ### -EncryptionParameters +> Applicable: SharePoint Online + Parameters of the encryption, it doesn't accept wildcard characters. It accepts parameters like SHA384, SHA256, etc. @@ -65,7 +67,7 @@ It accepts parameters like SHA384, SHA256, etc. Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -76,13 +78,15 @@ Accept wildcard characters: False ### -MigrationSourceLocations +> Applicable: SharePoint Online + Possible Source locations to migrate ```yaml Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceParameterSet Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -93,13 +97,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Switch Parameter to determine if you should get or not a log file. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -110,13 +116,15 @@ Accept wildcard characters: False ### -SourceFilesPath +> Applicable: SharePoint Online + Defines the temporary Path where are located the XML source files. ```yaml Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -127,13 +135,15 @@ Accept wildcard characters: False ### -SourcePackagePath +> Applicable: SharePoint Online + Defines the source package path location. ```yaml Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -144,13 +154,15 @@ Accept wildcard characters: False ### -TargetFilesPath +> Applicable: SharePoint Online + Defines the temporary Path where are located the XML source files. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -161,13 +173,15 @@ Accept wildcard characters: False ### -TargetPackagePath +> Applicable: SharePoint Online + Defines the source package path location of the package to be encrypted. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md index a5ab91ed5..5f9d9c325 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md @@ -53,13 +53,15 @@ $finalPackages = ConvertTo-SPOMigrationTargetedPackage -ParallelImport -SourceFi ### -AzureADUserCredentials +> Applicable: SharePoint Online + Receives Microsoft Entra User Credentials ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -70,13 +72,15 @@ Accept wildcard characters: False ### -Credentials +> Applicable: SharePoint Online + Fill out the Regular Credentials (Get-Credential) ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -87,13 +91,15 @@ Accept wildcard characters: False ### -NoAzureADLookup +> Applicable: SharePoint Online + Switch parameter that says if the command should or should not look up for Microsoft Entra ID. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -104,13 +110,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Switch Parameter to determine if you should get or not a log file. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -121,13 +129,15 @@ Accept wildcard characters: False ### -OutputPackagePath +> Applicable: SharePoint Online + Output package path ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 2 @@ -138,13 +148,15 @@ Accept wildcard characters: False ### -ParallelImport +> Applicable: SharePoint Online + Switch parameter to boost file share migration performance. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -155,13 +167,15 @@ Accept wildcard characters: False ### -PartitionSizeInBytes +> Applicable: SharePoint Online + Define the partition size in Bytes where it will be located the target package. ```yaml Type: System.Int64 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -172,13 +186,15 @@ Accept wildcard characters: False ### -SourceFilesPath +> Applicable: SharePoint Online + Defines the temporary Path where are located the XML source files. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -189,13 +205,15 @@ Accept wildcard characters: False ### -SourcePackagePath +> Applicable: SharePoint Online + Defines the source package path location. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -206,13 +224,15 @@ Accept wildcard characters: False ### -TargetDocumentLibraryPath +> Applicable: SharePoint Online + Defines the target document library path. ```yaml Type: System.String Parameter Sets: DocumentLibraryImport Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -223,13 +243,15 @@ Accept wildcard characters: False ### -TargetDocumentLibrarySubFolderPath +> Applicable: SharePoint Online + Defines the target document library subfolder path. ```yaml Type: System.String Parameter Sets: DocumentLibraryImport Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -240,6 +262,8 @@ Accept wildcard characters: False ### -TargetEnvironment +> Applicable: SharePoint Online + Defines the Target environment: Production, ProductionChina, None or OnPremises. ```yaml @@ -247,7 +271,7 @@ Type: Microsoft.Online.SharePoint.Migration.TargetEnvironment Parameter Sets: (All) Aliases: Accepted values: Production, ProductionChina, None, OnPremises -Applicable: SharePoint Online + Required: False Position: Named @@ -258,13 +282,15 @@ Accept wildcard characters: False ### -TargetListPath +> Applicable: SharePoint Online + Defines the Target list path ```yaml Type: System.String Parameter Sets: ListImport Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -275,13 +301,15 @@ Accept wildcard characters: False ### -TargetWebUrl +> Applicable: SharePoint Online + Defines the Target Web URL of the package. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 3 @@ -292,13 +320,15 @@ Accept wildcard characters: False ### -UserMappingFile +> Applicable: SharePoint Online + Defines the file mapping of the user. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md index 2a94781a2..c15d38e81 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md @@ -110,13 +110,15 @@ Example 4 demonstrates how a SharePoint Administrator can move the SharePoint pa ### -DeleteSourcePage +> Applicable: SharePoint Online + Indicates whether to delete the source SharePoint page(s) after copying. If specified, the operation will move the SharePoint page(s) instead of copying. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -127,13 +129,15 @@ Accept wildcard characters: False ### -DestinationSite +> Applicable: SharePoint Online + Specifies the URL of the destination SharePoint site where the SharePoint pages will be copied to. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -144,13 +148,15 @@ Accept wildcard characters: False ### -PageName +> Applicable: SharePoint Online + Specifies the name of the SharePoint page to copy. This parameter is required when not using the `-AllPages` switch. Note that `-PageName` refers to the name of a SharePoint page that ends with the suffix .aspx, such as page.aspx. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -161,13 +167,15 @@ Accept wildcard characters: False ### -SourceSite +> Applicable: SharePoint Online + Specifies the URL of the source SharePoint site containing the SharePoint pages to copy. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md index 6283004fe..d22842600 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md @@ -75,6 +75,8 @@ We do not support sites that currently have or have had in the past enabled the ### -DesignPackageId +> Applicable: SharePoint Online + GUID identifying the [communication site design](https://support.office.com/article/what-is-a-sharepoint-communication-site-94a33429-e580-45c3-a090-5512a8070732). **This is not a required input.** If no input is provided, the topic design will be applied to the new home page. here are the IDs for the supported design packages: 1. Topic: 96c933ac-3698-44c7-9f4a-5fd17d71af9e @@ -85,7 +87,7 @@ GUID identifying the [communication site design](https://support.office.com/arti Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -95,13 +97,15 @@ Accept wildcard characters: False ### -SiteUrl +> Applicable: SharePoint Online + URL of the site for enabling the modern communication site experience. **This is a required parameter** ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md index 22afd580a..f7de90e81 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md @@ -63,13 +63,15 @@ Example 2 exports the query log from the starting time 21. October 2018, for a u ### -LoginName +> Applicable: SharePoint Online + Specifies the login name of the user to export. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -80,13 +82,15 @@ Accept wildcard characters: False ### -OutputFolder +> Applicable: SharePoint Online + Target folder where the CSV file is generated. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -97,13 +101,15 @@ Accept wildcard characters: False ### -StartTime +> Applicable: SharePoint Online + Specifies from which point of time to export the logs from. Use the date format YYYY-MM-DD. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md index 4dd3120ae..4984dd1ab 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md @@ -56,13 +56,15 @@ Example 2 exports user data who has email address joe.healy@contoso.com from all ### -LoginName +> Applicable: SharePoint Online + Specifies the login name of the user to export. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ### -OutputFolder +> Applicable: SharePoint Online + Target folder where the CSV file is generated. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site collection to which you want to export the user. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md index 282fbbf6c..125b810b9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md @@ -42,13 +42,15 @@ Example 1 exports user data who has the e-mail address joe.healy@contoso.com to ### -LoginName +> Applicable: SharePoint Online + Specifies the login name of the user whose data is exported. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ### -OutputFolder +> Applicable: SharePoint Online + Specifies the output folder location where the CSV file is created. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md index b11b3319a..4004370a5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md @@ -39,13 +39,15 @@ For permissions and the most current information about Windows PowerShell for Sh ### -FileUrl +> Applicable: SharePoint Online + Full URL for the file. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md index b21ed002d..47bdc81ae 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md @@ -60,13 +60,15 @@ This example returns a collection of monitoring error message(s) for application ### -EndTimeInUtc +> Applicable: SharePoint Online + Specifies the end time in UTC to search for monitoring errors. If no end time is given, the default value current time in UTC is used. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -77,13 +79,15 @@ Accept wildcard characters: False ### -ProductId +> Applicable: SharePoint Online + Specifies the application's GUID. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -94,13 +98,15 @@ Accept wildcard characters: False ### -StartTimeInUtc +> Applicable: SharePoint Online + Specifies the start time in UTC to search for monitoring errors. If no start time is given, the default value 72 hours before the current time is used. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md index 1e23ce4c4..5eeaf5c6b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md @@ -64,13 +64,15 @@ Example 3 returns all the installed applications that have a space in the name a ### -Name +> Applicable: SharePoint Online + Specifies the application's name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 2 @@ -81,13 +83,15 @@ Accept wildcard characters: False ### -ProductId +> Applicable: SharePoint Online + Specifies the application's GUID. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md index f04c33671..4b29cdbed 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md @@ -126,6 +126,8 @@ Example 8 returns a tabular list of recently archived containers belonging to th ### -ArchiveStatus +> Applicable: SharePoint Online + The ArchiveStatus parameter is used to display containers in various stages of archiving. The following states are supported: - Archived – Displays containers in all archived states. @@ -140,7 +142,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPContainerArchiveStatusF Parameter Sets: Archive Aliases: Accepted values: NotArchived, FullyArchived, RecentlyArchived, Reactivating, Archived -Applicable: SharePoint Online + Required: True Position: 1 @@ -151,13 +153,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + Use this parameter to specify the Container ID. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: Identity Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -168,13 +172,15 @@ Accept wildcard characters: False ### -OwningApplicationId +> Applicable: SharePoint Online + This parameter specifies the ID of the SharePoint Embedded application. Use the `Get-SPOApplication` command to retrieve the OwningApplicationId. ```yaml Type: System.Guid Parameter Sets: OwningApplicationId, Sort, Archive Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -185,13 +191,15 @@ Accept wildcard characters: False ### -Paged +> Applicable: SharePoint Online + This parameter can be used when there are more than 200 containers in a given SharePoint Embedded application. Using `-Paged` will provide a paging token that will display the next 200 Containers. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: OwningApplicationId, Sort, Archive Aliases: -Applicable: SharePoint Online + Required: False Position: 1 @@ -203,13 +211,15 @@ Accept wildcard characters: False ### -PagingToken +> Applicable: SharePoint Online + Use this parameter to provide the paging token to view the remaining containers as shown in Example 4. If there are no more containers to display, the cmdlet output will return the message `End of containers view.` Otherwise, use the given paging token to retrieve the next batch of up to 200 containers. For displaying the next set of archived containers, `-ArchiveStatus` paramter needs to be used along with this parameter. ```yaml Type: System.String Parameter Sets: OwningApplicationId, Sort, Archive Aliases: -Applicable: SharePoint Online + Required: False Position: 2 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md index c250c74ce..93206905a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md @@ -61,13 +61,15 @@ Example 2 returns the detailed properties of container type 4f0af585. ### -ContainerTypeId +> Applicable: SharePoint Online + This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md index ce0d1dd6f..0202f2f3c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md @@ -42,13 +42,15 @@ This example returns a list of configurations set on a container type '4f0af585- ### -ContainerTypeId +> Applicable: SharePoint Online + This parameter specifies the ID of the SharePoint Embedded container type. Use the `Get-SPOContainerType` command to retrieve the ContainerTypeId. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentEventEmailAddresses.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentEventEmailAddresses.md index 09a7dca5c..bbe5800ad 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentEventEmailAddresses.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentEventEmailAddresses.md @@ -41,6 +41,8 @@ In Example 1, the system will display the email addresses categorized under rans ### -Category +> Applicable: SharePoint Online + Specifies the content event category. ```yaml @@ -48,7 +50,7 @@ Type: Microsoft.SharePoint.Administration.TenantAdmin.ContentEventCategory Parameter Sets: (All) Aliases: Accepted values: Unknown, Ransomware, HighVolumeDownload, HighVolumeDelete, HighVolumeShare -Applicable: SharePoint Online + Required: False Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md index bc559f05e..a2bab9afa 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md @@ -71,6 +71,8 @@ Example 3 enables administrator to download the Copilot agent insight report of ### -Action +> Applicable: SharePoint Online + It determines whether a report would be viewed or downloaded. If the value of `-Action` is set as `View`, it will display the output on the PowerShell screen. Else if the value of `-Action` is set as `Download`, it will download the full report in CSV format to the same path from where the command was run. ```yaml @@ -78,8 +80,8 @@ Type: ActionType Parameter Sets: (All) Aliases: Accepted values: View, Download -Applicable: SharePoint Online - + + Required: False Position: Named Default value: View @@ -89,6 +91,8 @@ Accept wildcard characters: False ### -Content +> Applicable: SharePoint Online + It specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution. If this cmdlet is executed with `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in the specified number of days will be displayed with the following properties: @@ -132,10 +136,10 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOCopilotAgentInsightTyp Parameter Sets: (All) Aliases: Accepted values: CopilotAgentsOnSites, TopSites, SiteDistribution -Applicable: SharePoint Online + Required: False -Position: Named +Position: Named Default value: CopilotAgentsOnSites Accept pipeline input: False Accept wildcard characters: False @@ -143,14 +147,16 @@ Accept wildcard characters: False ### -ReportId +> Applicable: SharePoint Online + It specifies the unique Id of the report to be viewed or downloaded. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online - + + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMoveReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMoveReport.md index eccc57d01..fa4766420 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMoveReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMoveReport.md @@ -41,13 +41,15 @@ This example returns the failed site moves between geo locations. ### -Limit +> Applicable: SharePoint Online + Limit the number of items to return for the report. ```yaml Type: System.UInt32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -57,6 +59,8 @@ Accept wildcard characters: False ### -MoveDirection +> Applicable: SharePoint Online + The direction of the move to limit the report to. Valid values are: * All @@ -67,7 +71,7 @@ The direction of the move to limit the report to. Valid values are: Type: Microsoft.Online.SharePoint.PowerShell.MoveDirection Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -77,13 +81,15 @@ Accept wildcard characters: False ### -MoveEndTime +> Applicable: SharePoint Online + The end time to limit the move report to. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -93,6 +99,8 @@ Accept wildcard characters: False ### -MoveJobType +> Applicable: SharePoint Online + The type of job to limit the report to. Valid values are: * GroupMove @@ -104,7 +112,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.JobType Parameter Sets: (All) Aliases: Accepted values: UserMove, GroupMove, SiteMove -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -114,13 +122,15 @@ Accept wildcard characters: False ### -MoveStartTime +> Applicable: SharePoint Online + The start time to limit the move report to. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -130,6 +140,8 @@ Accept wildcard characters: False ### -MoveState +> Applicable: SharePoint Online + The type of state to limit the report to. Valid values are: * All @@ -147,7 +159,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.MoveState Parameter Sets: (All) Aliases: Accepted values: NotStarted, InProgress, Success, Failed, Stopped, Queued, NotSupported, Rescheduled, All -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md index 819e3d62e..365486f02 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md @@ -47,6 +47,8 @@ Get the cross users that have been moved out the current SPO site ## PARAMETERS ### -Direction + +> Applicable: SharePoint Online Used to specify move direction. Possible values @@ -59,7 +61,7 @@ Type: System.String Parameter Sets: (All) Aliases: Accepted values: MoveIn, MoveOut -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md index 5da316199..b3f38723e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md @@ -56,6 +56,8 @@ Returns a single user from SharePoint Online in a multi-geo tenant and validates ### -ValidDataLocation +> Applicable: SharePoint Online + Use this parameter to validate the location of the data. The acceptable values for this parameter are: - $False @@ -65,7 +67,7 @@ Use this parameter to validate the location of the data. The acceptable values f Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md index 1fca492ed..9020ecc54 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md @@ -42,13 +42,15 @@ Gets the compatibility status with the partner tenant Contoso. ## PARAMETERS ### -PartnerCrossTenantHostUrl + +> Applicable: SharePoint Online The cross-tenant URL of the partner tenant. The partner tenant can determine this for you by running `Get-SPOCrossTenantHostUrl` on each of the tenants. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md index 8acaaf822..ae326c468 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md @@ -62,13 +62,15 @@ The command in this example returns all deleted site collections from the Recycl ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the deleted site collection to be returned. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 1 @@ -79,13 +81,15 @@ Accept wildcard characters: False ### -IncludeOnlyPersonalSite +> Applicable: SharePoint Online + Use this switch parameter to only include Personal Sites in the returned results. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ParameterSetPersonalSitesOnly Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -96,13 +100,15 @@ Accept wildcard characters: False ### -IncludePersonalSite +> Applicable: SharePoint Online + Use this switch parameter to include Personal Sites with the returned results. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ParameterSetAllSites Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -113,6 +119,8 @@ Accept wildcard characters: False ### -Limit +> Applicable: SharePoint Online + Specifies the maximum number of site collections to return. It can be any number. To retrieve all site collections, use ALL. @@ -122,7 +130,7 @@ The default value is 200. Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md index a7a08f797..be89071f4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md @@ -80,6 +80,8 @@ Example 3 enables administrator to download the enterprise application insights ### -Action +> Applicable: SharePoint Online + It is an optional parameter, and it specifies whether to view or download a specific report. ```yaml @@ -87,7 +89,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.GetSPOEnterpriseAppInsightsReport+A Parameter Sets: (All) Aliases: Accepted values: View, Download -Applicable: SharePoint Online + Required: False Position: Named @@ -98,13 +100,15 @@ Accept wildcard characters: False ### -ReportId +> Applicable: SharePoint Online + It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded. ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md index a2ef3e912..86f278be4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md @@ -60,13 +60,15 @@ Example 3 returns the first 30 users that match the SiteUrl Applicable: SharePoint Online + Limits the results to only those users whose first name, last name, or email address begins with the text in the string using a case-insensitive comparison. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 4 @@ -77,6 +79,8 @@ Accept wildcard characters: False ### -PageSize +> Applicable: SharePoint Online + Specifies the maximum number of users to be returned in the collection. The value must be less than or equal to 50. @@ -85,7 +89,7 @@ The value must be less than or equal to 50. Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 3 @@ -96,13 +100,15 @@ Accept wildcard characters: False ### -Position +> Applicable: SharePoint Online + Use to specify the zero-based index of the position in the sorted collection of the first result to be returned. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 2 @@ -113,13 +119,15 @@ Accept wildcard characters: False ### -ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount +> Applicable: SharePoint Online + Shows users who have accepted an invite but not using the account the invite was sent to. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -130,6 +138,8 @@ Accept wildcard characters: False ### -SiteUrl +> Applicable: SharePoint Online + Specifies the site to retrieve external users for. If no site is specified, the external users for all sites are returned. @@ -138,7 +148,7 @@ If no site is specified, the external users for all sites are returned. Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 6 @@ -149,13 +159,15 @@ Accept wildcard characters: False ### -SortOrder +> Applicable: SharePoint Online + Specifies the sort results in Ascending or Descending order on the SPOUser.Email property should occur. ```yaml Type: Microsoft.Online.SharePoint.TenantManagement.SortOrder Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 5 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md index d8db0e43f..76a587f28 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md @@ -50,13 +50,15 @@ Get the storage size quota of the current location. ### -AllLocations +> Applicable: SharePoint Online + Use this parameter to retrieve the storage size quota of all locations. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md index f7f8d3be8..c07e0565a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md @@ -66,13 +66,15 @@ This example begins with the online-marketing site. The cmdlet finds the associa ### -Identity +> Applicable: SharePoint Online + URL of the hub site. If not specified, the cmdlet lists all hub sites in the tenant. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionBatchDeleteJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionBatchDeleteJobProgress.md index d5e2172dd..309f825bd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionBatchDeleteJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionBatchDeleteJobProgress.md @@ -58,13 +58,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionExpirationReportJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionExpirationReportJobProgress.md index 9d7bef139..2c1dd4419 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionExpirationReportJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionExpirationReportJobProgress.md @@ -74,13 +74,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListVersionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListVersionPolicy.md index bd88b7263..9f1a3582b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListVersionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListVersionPolicy.md @@ -57,13 +57,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md index fe63d054e..07dc9b361 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md @@ -43,13 +43,15 @@ Example 1 returns an object of the type `SPOMalwareFile` which contains siteURL, ### -FileUri +> Applicable: SharePoint Online + Full URL for the file. ```yaml Type: System.Uri Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md index 4bd4d7d37..997d30de6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md @@ -73,13 +73,15 @@ Example 3 downloads the file to the current working directory using the original ### -MalwareInfectedFile +> Applicable: SharePoint Online + `SPOMalwareFile` object returned by `Get-SPOMalwareFile` cmdlet. ```yaml Type: Microsoft.Online.SharePoint.TenantAdministration.SPOMalwareFile Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md index 2bb3dcd55..34eebaa50 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md @@ -86,13 +86,15 @@ This will report on any currently queued or in progress jobs and not wait for al ### -AzureQueueUri +> Applicable: SharePoint Online + An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import. ```yaml Type: System.String Parameter Sets: AzureLocationsInline Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -103,13 +105,15 @@ Accept wildcard characters: False ### -Credentials +> Applicable: SharePoint Online + Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session's previous call to `Connect-SPOService` will be used to connect to the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -120,13 +124,15 @@ Accept wildcard characters: False ### -DontWaitForEndJob +> Applicable: SharePoint Online + Tells the cmdlet to not wait for the job to end. It will only process as many messages as are currently in the queue and then terminate. If this flag is set to $false, it will wait for the job to end before terminating. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -137,13 +143,15 @@ Accept wildcard characters: False ### -EncryptionParameters +> Applicable: SharePoint Online + An EncryptionParameters object. See New-SPOMigrationEncryptionParameters https://learn.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters for more information. ```yaml Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -154,13 +162,15 @@ Accept wildcard characters: False ### -JobIds +> Applicable: SharePoint Online + Id of a previously created migration job that exists on the target site collection. ```yaml Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -171,13 +181,15 @@ Accept wildcard characters: False ### -MigrationPackageAzureLocations +> Applicable: SharePoint Online + A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the `Set-SPOMigrationPackageAzureSource` ```yaml Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: AzureLocationsImplicit Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -188,13 +200,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Indicates to not create a log file. The default is to create a new CopyMigrationPackage log file within the directory specified within the SourcePackagePath parameter. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -205,13 +219,15 @@ Accept wildcard characters: False ### -TargetWebUrl +> Applicable: SharePoint Online + The fully qualified target web URL where the package will be imported into. This must include the same TargetWebURL that was used during `ConvertTo-SPOMigrationTargetedPackage`. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md index abf282ea8..cdb900685 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md @@ -46,13 +46,15 @@ You can obtain the Job id when submit package data to create new SPO migration j ### -Credentials +> Applicable: SharePoint Online + The credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session's previous call to `Connect-SPOService` will be used to connect to the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ### -JobId +> Applicable: SharePoint Online + (optional) The ID of a migration job that exists on the target site collection. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -80,13 +84,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + (optional) Indicates to not create a log file. The default is to create a new DeleteMigrationJob log file within the current directory. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -97,13 +103,15 @@ Accept wildcard characters: False ### -TargetWebUrl +> Applicable: SharePoint Online + The fully qualified target web URL where the package will be imported. This must include the same TargetWebUrl that was used during `ConvertTo-SPOMigrationTargetedPackage`. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md index 752931ebd..6f15a3ab2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md @@ -66,13 +66,15 @@ Example 1 shows how a SharePoint Administrator can check the status of a copy op ### -DestinationSite +> Applicable: SharePoint Online + Specifies the URL of the destination SharePoint site to which the SharePoint page has been copied to. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -83,13 +85,15 @@ Accept wildcard characters: False ### -WorkItemId +> Applicable: SharePoint Online + Specifies the GUID of the work item created for the copy job if it is asynchronous. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreation.md index 9cdf83da8..0ed61f371 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreation.md @@ -50,6 +50,8 @@ Example 2 returns a comma-separated list of the IDs of the Microsoft Entra secur ## PARAMETERS ### -SiteType + +> Applicable: SharePoint Online When provided, only return the Microsoft Entra security groups configured for the specified site type. PARAMVALUE: All | SharePoint | OneDrive | Team | Communication @@ -64,7 +66,7 @@ Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCre Parameter Sets: (All) Aliases: Accepted values: All, SharePoint, OneDrive, Team, Communication -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index d30c90d8d..5c649f8cc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -162,6 +162,8 @@ This example retrieves all sites filtering by the specified owner using a variab ### -ArchiveStatus +> Applicable: SharePoint Online + Displays sites of a specific archive status. For example, NotArchived, RecentlyArchived, FullyArchived, Archived, or Reactivating. ```yaml @@ -169,7 +171,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.ArchiveStatusFilterType Parameter Sets: ParamSet2 Aliases: Accepted values: NotArchived, FullyArchived, RecentlyArchived, Reactivating, Archived -Applicable: SharePoint Online + Required: False Position: Named @@ -180,6 +182,8 @@ Accept wildcard characters: False ### -Detailed +> Applicable: SharePoint Online + Use this parameter to get additional property information on a site collection. You will notice a slower response time when the Detailed parameter is used. The following properties are returned: @@ -203,7 +207,7 @@ Returns the effective access level, which is the site policy and the tenant poli Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet1, ParamSet2 Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -214,6 +218,8 @@ Accept wildcard characters: False ### -DisableSharingForNonOwnersStatus +> Applicable: SharePoint Online + This parameter prevents non-owners from sharing. > [!NOTE] @@ -223,7 +229,7 @@ This parameter prevents non-owners from sharing. Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet3 Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -234,6 +240,8 @@ Accept wildcard characters: False ### -Filter +> Applicable: SharePoint Online + Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value must be in the form `{ PropertyName "filterValue"}`. Valid operators are as follows: -eq, -ne, -like, -notlike. Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url. Using the -or operator to include an additional filter is not supported. @@ -244,7 +252,7 @@ Note: The operator values are case-sensitive. Type: System.String Parameter Sets: ParamSet2 Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -255,6 +263,8 @@ Accept wildcard characters: False ### -GroupIdDefined +> Applicable: SharePoint Online + Filters the list of sites returned to sites with a Group ID (ie: Sites connected to an Microsoft 365 Group) when the value is set to $true. Filters the list of sites to only sites without a Group ID when the value is $false. The values are **$true**, **$false**, and **not defined**. By default, the value is **not defined**, which means that the filter does not apply. @@ -263,7 +273,7 @@ The values are **$true**, **$false**, and **not defined**. By default, the value Type: System.Boolean Parameter Sets: ParamSet2 Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -274,13 +284,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: ParamSet1, ParamSet3 Aliases: -Applicable: SharePoint Online + Required: False Position: 0 @@ -291,6 +303,8 @@ Accept wildcard characters: False ### -IncludePersonalSite +> Applicable: SharePoint Online + Displays personal sites when value is set to $true. The values are $true and $false. By default, the value is $false which means no personal sites will be returned. @@ -299,7 +313,7 @@ The values are $true and $false. By default, the value is $false which means no Type: System.Boolean Parameter Sets: ParamSet2 Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -310,13 +324,15 @@ Accept wildcard characters: False ### -Limit +> Applicable: SharePoint Online + Specifies the maximum number of site collections to return. It can be any number. To retrieve all site collections, use ALL. The default value is 200. If this parameter is provided, then some site collection properties will not be populated and may contain a default value. ```yaml Type: System.String Parameter Sets: ParamSet1, ParamSet2 Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -327,13 +343,15 @@ Accept wildcard characters: False ### -Template +> Applicable: SharePoint Online + Displays sites of a specific template. For example, STS, STS#0, STS#1, STS#3, GROUP#0, SRCHCEN#0 or SITEPAGEPUBLISHING#0. ```yaml Type: System.String Parameter Sets: ParamSet2 Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteCollectionAppCatalogs.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteCollectionAppCatalogs.md index c1d9d7e28..0856c7723 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteCollectionAppCatalogs.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteCollectionAppCatalogs.md @@ -40,13 +40,15 @@ This example returns the Site Collection App Catalog for the site Applicable: SharePoint Online + Url of the site ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md index 33d9616af..feaf0751e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteContentMoveState.md @@ -154,13 +154,15 @@ Accept wildcard characters: False ``` ### -SourceSiteUrl + +> Applicable: SharePoint Online Specifies the source URL of the site collection. ```yaml Type: System.String Parameter Sets: SourceSiteUrl Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDataEncryptionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDataEncryptionPolicy.md index e8fb6eb9f..a86f8c8bc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDataEncryptionPolicy.md @@ -42,13 +42,15 @@ Verifies the encryption of the site https://contoso.sharepoint.com/sites/Researc ### -Identity +> Applicable: SharePoint Online + The URL of the Site Collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesign.md index b575a4d85..d17fa1288 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesign.md @@ -47,13 +47,15 @@ Description : Use this design to apply Contoso theme and create ### -Identity +> Applicable: SharePoint Online + The ID of the site design to retrieve. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRights.md index 5ee74a949..c1238775a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRights.md @@ -44,13 +44,15 @@ Nestor Wilke i:0#.f|membership|nestorw@contoso.onmicrosoft.com View ### -Identity +> Applicable: SharePoint Online + The ID of the site design to get scoping information. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignTask.md index 6d0961ba9..f83aade4b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignTask.md @@ -43,13 +43,15 @@ This example returns a scheduled site design whose ID is 501z8c32-4147-44d4-8607 ### -Identity +> Applicable: SharePoint Online + The ID of the scheduled site design to apply. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 0 Default value: None @@ -59,13 +61,15 @@ Accept wildcard characters: False ### -WebUrl +> Applicable: SharePoint Online + The URL of the site collection where the site design will be applied. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionBatchDeleteJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionBatchDeleteJobProgress.md index fd0162ab7..823a4802e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionBatchDeleteJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionBatchDeleteJobProgress.md @@ -41,13 +41,15 @@ Example 1 gets the progress of a trim job for a site collection. ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionExpirationReportJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionExpirationReportJobProgress.md index 8750b4053..13c862730 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionExpirationReportJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionExpirationReportJobProgress.md @@ -42,13 +42,15 @@ Example 1 gets the status for a file version expiration report generation job fo ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md index 6fa409d9b..89b35ccbc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md @@ -44,13 +44,15 @@ This example returns all the groups on the specified site collection Applicable: SharePoint Online + Specifies the group name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -61,13 +63,15 @@ Accept wildcard characters: False ### -Limit +> Applicable: SharePoint Online + Specifies the maximum number of groups to return. The default value is 200. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -78,13 +82,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the site collection scope. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md index e148d4bed..1a9874c78 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSitePages.md @@ -50,13 +50,15 @@ Example 1 demonstrates how a SharePoint Administrator can retrieve all the Share ### -Site +> Applicable: SharePoint Online + Specifies the URL of the SharePoint site from which to fetch the SharePoint pages. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteRenameState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteRenameState.md index 6a0f72d5c..6721b8e44 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteRenameState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteRenameState.md @@ -69,13 +69,15 @@ This example returns rename jobs that were initiated by a tenant rename. ### -Identity +> Applicable: SharePoint Online + The urls of the site to be renamed. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: SourceSiteUrl Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -85,13 +87,15 @@ Accept wildcard characters: False ### -ParentOperationId +> Applicable: SharePoint Online + The parent operation id that initiated the site to be renamed. For example, the tenant rename job id. ```yaml Type: System.Guid Parameter Sets: ParentId Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -101,6 +105,8 @@ Accept wildcard characters: False ### -State +> Applicable: SharePoint Online + The state of the rename job, possible values are - Queued @@ -114,7 +120,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.RenameState Parameter Sets: ParentId, RenameReport Aliases: Accepted values: Queued, InProgress, Success, Failed, Suspended, Canceling, Canceled -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -124,6 +130,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -131,7 +139,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -141,6 +149,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -148,7 +158,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScript.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScript.md index 8a18b0f7c..ebc46dc17 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScript.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScript.md @@ -56,13 +56,15 @@ Version : 1 ### -Identity +> Applicable: SharePoint Online + The ID of the site script to get information about. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromList.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromList.md index 9112ecdee..32366aa70 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromList.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromList.md @@ -44,13 +44,15 @@ Add-SPOSiteScript ` ### -ListUrl +> Applicable: SharePoint Online + The url of the list to be referenced for the JSON output. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromWeb.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromWeb.md index e8b28989a..927495383 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromWeb.md @@ -53,13 +53,15 @@ C:\> Add-SPOSiteScript ` ### -IncludeBranding +> Applicable: SharePoint Online + A switch that if provided, extracts the configuration of the site's branding. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -69,6 +71,8 @@ Accept wildcard characters: False ### -IncludedLists +> Applicable: SharePoint Online + An array of one or more lists. Each is identified by the list url. Note: Currently, navigation nodes are not exported. @@ -77,7 +81,7 @@ Note: Currently, navigation nodes are not exported. Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -87,13 +91,15 @@ Accept wildcard characters: False ### -IncludeLinksToExportedItems +> Applicable: SharePoint Online + A switch that if provided, extracts navigation links. In order to export navigation links pointing to lists, the list needs to be included in the request as well. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -103,13 +109,15 @@ Accept wildcard characters: False ### -IncludeRegionalSettings +> Applicable: SharePoint Online + A switch that if provided, extracts the site's regional settings. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -119,13 +127,15 @@ Accept wildcard characters: False ### -IncludeSiteExternalSharingCapability +> Applicable: SharePoint Online + A switch that if provided, extracts the site's external sharing capability. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -135,13 +145,15 @@ Accept wildcard characters: False ### -IncludeTheme +> Applicable: SharePoint Online + A switch that if provided, extracts the site's custom theme by using the themeJson property. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -151,13 +163,15 @@ Accept wildcard characters: False ### -WebUrl +> Applicable: SharePoint Online + The url that starts with HTTPS of the site to retrieve the site script. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteUserInvitations.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteUserInvitations.md index f99c44f55..2d559f28b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteUserInvitations.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteUserInvitations.md @@ -40,13 +40,15 @@ This example retrieves email invites stored in the ContosoWeb1 site to the user ### -EmailAddress +> Applicable: SharePoint Online + Email Address of the user. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 Default value: None @@ -56,13 +58,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteVersionPolicyJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteVersionPolicyJobProgress.md index fb9d6f6ef..f417938c3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteVersionPolicyJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteVersionPolicyJobProgress.md @@ -40,13 +40,15 @@ Example 1 gets the progress of setting version policy for existing document libr ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStorageEntity.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStorageEntity.md index d0af6c14e..1bea7211e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStorageEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStorageEntity.md @@ -41,13 +41,15 @@ This example returns the whole entry in the property bag. ### -Key +> Applicable: SharePoint Online + The key in the property bag that should be returned. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + URL to the tenant or site collection app catalog. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md index b78c66d7e..237893ca9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md @@ -37,13 +37,15 @@ This example checks if structural navigation caching is enabled for the entire s ## PARAMETERS ### -SiteUrl + +> Applicable: SharePoint Online Specifies the absolute URL for the site collection's root web being checked for its caching state. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheWebState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheWebState.md index eb6106594..10a103923 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheWebState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheWebState.md @@ -37,13 +37,15 @@ This example checks if structural navigation caching is enabled for the web http ## PARAMETERS ### -WebUrl + +> Applicable: SharePoint Online Specifies the absolute URL for the web being checked for its caching state. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md index 002e44a29..4aebfbc65 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md @@ -40,6 +40,8 @@ The example returns a CDN with a type of public. ### -CdnType +> Applicable: SharePoint Online + Specifies the CDN type. The valid values are Public or Private. ```yaml @@ -47,7 +49,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md index e2b775e3d..fcdb01dca 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md @@ -40,6 +40,8 @@ The example returns a list of origins from the Tenant. ### -CdnType +> Applicable: SharePoint Online + Specifies the CDN type. The valid values are: Public or Private. ```yaml @@ -47,7 +49,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md index b46937279..cc179f7b8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md @@ -48,6 +48,8 @@ This example returns private CDN policies of your tenant. ### -CdnType +> Applicable: SharePoint Online + Type of CDN on the current SPO Tenant (Public,Private) ```yaml @@ -55,7 +57,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md index 211079ace..ae9ff55bf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md @@ -99,13 +99,15 @@ This example retrieves log entries recorded over that previous 14 days that have ### -CorrelationId +> Applicable: SharePoint Online + Specifies the Correlation ID as a filter. ```yaml Type: System.Guid Parameter Sets: CorrelationId Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -116,13 +118,15 @@ Accept wildcard characters: False ### -EndTimeInUtc +> Applicable: SharePoint Online + Specifies the end time in UTC to search for logs. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 1 @@ -133,13 +137,15 @@ Accept wildcard characters: False ### -MaxRows +> Applicable: SharePoint Online + Specifies the maximum number of rows in the descending order of timestamp. The value must be less than 5000. The default value is 1000. ```yaml Type: System.UInt32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 2 @@ -150,13 +156,15 @@ Accept wildcard characters: False ### -Source +> Applicable: SharePoint Online + Specifies the component that logs the errors. ```yaml Type: System.Int32 Parameter Sets: Source Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -167,13 +175,15 @@ Accept wildcard characters: False ### -StartTimeInUtc +> Applicable: SharePoint Online + Specifies the start time in Coordinated Universal Time (UTC) to search for the logs (for example, 01032011:12:00). ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 0 @@ -184,13 +194,15 @@ Accept wildcard characters: False ### -User +> Applicable: SharePoint Online + Specifies the log-on identity as a filter. ```yaml Type: System.String Parameter Sets: User Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroup.md index 52d877182..3e1f585ad 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroup.md @@ -39,13 +39,15 @@ Returns the PDL for the Office 365 Group named 'EUTeam'. ### -GroupAlias +> Applicable: SharePoint Online + The alias of the Office 365 Group. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroupMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroupMoveState.md index dbf7281bf..c2abb0897 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroupMoveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroupMoveState.md @@ -40,13 +40,15 @@ Returns the status of the move between geos for the Office 365 Group named 'EUTe ### -GroupAlias +> Applicable: SharePoint Online + The alias of the Office 365 Group. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md index be03a03e5..91a1a4a5e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md @@ -75,13 +75,15 @@ Example 3 returns one user or security group account inside group Team Site Memb ### -Group +> Applicable: SharePoint Online + Specifies the group to get the users from. ```yaml Type: System.String Parameter Sets: ByGroup Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -92,13 +94,15 @@ Accept wildcard characters: False ### -Limit +> Applicable: SharePoint Online + Specifies the maximum number of users returned. The default value is to return 500 users. To return all users specify the value "All". ```yaml Type: System.String Parameter Sets: All, ByGroup Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -109,13 +113,15 @@ Accept wildcard characters: False ### -LoginName +> Applicable: SharePoint Online + Specifies the user name. ```yaml Type: System.String Parameter Sets: ByLogin Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -126,13 +132,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site collection to get the user from. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md index ef88772c9..b498c6cac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md @@ -104,13 +104,15 @@ Obtains the status of the move for jezz@contoso.com ### -Limit +> Applicable: SharePoint Online + Get the limit of user on a single call of the parameter ```yaml Type: System.UInt32 Parameter Sets: MoveReport Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -138,13 +140,15 @@ Accept wildcard characters: False ### -MoveEndTime +> Applicable: SharePoint Online + Allows you to obtain the moves that are scheduled to end by a particular time, as defined in UTC ```yaml Type: System.DateTime Parameter Sets: MoveReport Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -155,13 +159,15 @@ Accept wildcard characters: False ### -MoveStartTime +> Applicable: SharePoint Online + Allows you to obtain the moves that are scheduled to begin at a particular time, as defined in UTC ```yaml Type: System.DateTime Parameter Sets: MoveReport Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -172,6 +178,8 @@ Accept wildcard characters: False ### -MoveState +> Applicable: SharePoint Online + Move State current status. ```yaml @@ -179,7 +187,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.MoveState Parameter Sets: MoveReport Aliases: Accepted values: NotStarted, InProgress, Success, Failed, Stopped, Queued, NotSupported, Rescheduled, All -Applicable: SharePoint Online + Required: False Position: Named @@ -190,13 +198,15 @@ Accept wildcard characters: False ### -OdbMoveId +> Applicable: SharePoint Online + OneDrive GUID MoveID that you get when you start a job. ```yaml Type: System.Guid Parameter Sets: OdbMoveId Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -207,13 +217,15 @@ Accept wildcard characters: False ### -UserPrincipalName +> Applicable: SharePoint Online + User Principal name is the unique property on Microsoft Entra ID for each user. ```yaml Type: String Parameter Sets: UserPrincipalName Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md index 24a89104b..1883202c9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md @@ -40,13 +40,15 @@ Get the current location the user's OneDrive location, url, and site ID. ### -UserPrincipalName +> Applicable: SharePoint Online + UserPrincipalName or UPN defined for the specific user on the SPO tenant. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md index f69758805..71bf41ce0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md @@ -53,13 +53,15 @@ Example 2 returns a list of all the French site templates. ### -CompatibilityLevel +> Applicable: SharePoint Online + Specifies the compatibility level of the site template. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -70,13 +72,15 @@ Accept wildcard characters: False ### -LocaleId +> Applicable: SharePoint Online + Specifies the Locale ID of the site template. ```yaml Type: System.UInt32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 0 @@ -87,13 +91,15 @@ Accept wildcard characters: False ### -Name +> Applicable: SharePoint Online + Specifies the name of the site template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -104,13 +110,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + Specifies the Locale ID of the site template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md index 388b5a2c9..170634793 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md @@ -45,13 +45,15 @@ This example shows how to grant rights to Nestor (a user at the fictional Contos ### -Identity +> Applicable: SharePoint Online + URL of the hub site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite -Applicable: SharePoint Online + Required: True Position: 0 @@ -62,13 +64,15 @@ Accept wildcard characters: False ### -Principals +> Applicable: SharePoint Online + One or more principals to add permissions for. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -79,6 +83,8 @@ Accept wildcard characters: False ### -Rights +> Applicable: SharePoint Online + Always set to the value **Join**. Any user or group with **Join** permissions can view and join the hub site. ```yaml @@ -86,7 +92,7 @@ Type: String Parameter Sets: (All) Aliases: Accepted values: Join -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOSiteDesignRights.md index f08caf591..2ee78bd32 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOSiteDesignRights.md @@ -44,13 +44,15 @@ Grant-SPOSiteDesignRights ` ### -Identity +> Applicable: SharePoint Online + The ID of the site design to get scoping information. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -60,13 +62,15 @@ Accept wildcard characters: False ### -Principals +> Applicable: SharePoint Online + One or more principles to add permissions for. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -76,6 +80,8 @@ Accept wildcard characters: False ### -Rights +> Applicable: SharePoint Online + Always set to the value **View**. Any user or group with view permissions can view and use the site design. ```yaml @@ -83,7 +89,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPrincipalRights Parameter Sets: (All) Aliases: Accepted values: View -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md index fc1c4ee09..151f8d488 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md @@ -74,13 +74,15 @@ $jobs = $finalPackages | % {Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesP ### -Credentials +> Applicable: SharePoint Online + Parameter to fill out credentials of the SPO tenant. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -91,13 +93,15 @@ Accept wildcard characters: False ### -MigrationSourceLocations +> Applicable: SharePoint Online + Migration Location where the package lies. ```yaml Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceParameterSet Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -108,13 +112,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Controls if a log will be created or not ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -140,13 +146,15 @@ Accept wildcard characters: False ### -SourceFilesPath +> Applicable: SharePoint Online + Source files Path, string ```yaml Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -157,13 +165,15 @@ Accept wildcard characters: False ### -SourcePackagePath +> Applicable: SharePoint Online + Source Package Path. ```yaml Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -174,13 +184,15 @@ Accept wildcard characters: False ### -TargetWebUrl +> Applicable: SharePoint Online + Target web URL ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteDesign.md index 1157d146a..afd1afe5b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteDesign.md @@ -55,13 +55,15 @@ Add to Hub Site Success ### -Identity +> Applicable: SharePoint Online + The ID of the site design to apply. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -70,13 +72,15 @@ Accept wildcard characters: False ``` ### -WebUrl + +> Applicable: SharePoint Online The URL of the site collection where the site design will be applied. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md index 6077cef10..497ea966d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md @@ -82,13 +82,15 @@ Archives the existing Search Center site at Applicable: SharePoint Online + URL that the target site will be archived to. There should be no existing site, including a deleted site in the Recycle Bin, at this location before performing the swap. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 @@ -99,13 +101,15 @@ Accept wildcard characters: False ### -DisableRedirection +> Applicable: SharePoint Online + Disables the site redirect from being created at the Source URL location. ```yaml Type: Switch Parameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -116,6 +120,8 @@ Accept wildcard characters: False ### -Force +> Applicable: SharePoint Online + Overrides and ignores any warnings that have been identified by the Page Diagnostic Tool that are preventing a swap from being initiated. For example, if you receive the warning "Invoke-SPOSiteSwap : Errors: 0; Warnings: 1; Details: 2 items are not in CDN, please enable CDN." Warnings can be overriden using this parameter but the items should be reviewed and resolved for long-term stability and performance. @@ -126,7 +132,7 @@ Any errors identified by the Page Diagnostic Tool will still always prevent a sw Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -137,13 +143,15 @@ Accept wildcard characters: False ### -NoWait +> Applicable: SharePoint Online + This parameter is reserved for internal Microsoft use. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -154,6 +162,8 @@ Accept wildcard characters: False ### -SourceUrl +> Applicable: SharePoint Online + URL of the source site. The site at this location must exist before performing the swap. If the target is the root site at `https://tenant-name.sharepoint.com` then the source site must be either a Modern Team Site (STS#3) or a Communication Site (SITEPAGEPUBLISHING#0) and **the publishing feature can never have been activated on the source site**. @@ -164,7 +174,7 @@ If the target is the search center site at `https://tenant-name.sharepoint.com/s Type: String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -175,6 +185,8 @@ Accept wildcard characters: False ### -TargetUrl +> Applicable: SharePoint Online + URL of the target site that the source site will be swapped to. The site at this location must exist before performing the swap. The target site must be either: @@ -186,7 +198,7 @@ The target site must be either: Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md index 1e69d04d7..5fcb27b31 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md @@ -58,13 +58,15 @@ New-SPOAppBillingPolicy -ApplicationId 50785fde-3082-47ac-a36d-06282ac5c7da -Az ### -ApplicationID +> Applicable: SharePoint Online + This parameter specifies the ID of the application. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -75,13 +77,15 @@ Accept wildcard characters: False ### -AzureRegion +> Applicable: SharePoint Online + The region of the Azure Subscription. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -92,13 +96,15 @@ Accept wildcard characters: False ### -AzureSubscriptionId +> Applicable: SharePoint Online + The unique identifier of the Azure Active Directory profile (Microsoft Entra ID) for billing purposes. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -109,13 +115,15 @@ Accept wildcard characters: False ### -ResourceGroup +> Applicable: SharePoint Online + Resource Group Name associated with the Azure Subscription ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -126,6 +134,8 @@ Accept wildcard characters: False ### -UsageCharges +> Applicable: SharePoint Online + This parameters determined who is charged for the usage of the application. This parameter supports two values - AppOwnerIsCharged or ConsumingTenantoftheAppischarged. - AppOwnerIsCharged : The tenant owning the application is charged for the usage - ConsumingTenantoftheAppischarged : The tenant using the application is charged for the usage. @@ -134,7 +144,7 @@ This parameters determined who is charged for the usage of the application. This Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md index 4636e7e36..e25b131f2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md @@ -71,13 +71,15 @@ In Example 4, the cmdlet creates a standard container type, ContosoLegal that ha ### -ApplicationRedirectUrl +> Applicable: SharePoint Online + This parameter specifies the url of that the application should be redirected to. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -88,13 +90,15 @@ Accept wildcard characters: False ### -ContainerTypeName +> Applicable: SharePoint Online + This parameter names your container type for your SharePoint Embedded application. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -105,13 +109,15 @@ Accept wildcard characters: False ### -IsGovernableByAdmin +> Applicable: SharePoint Online + Using `-GovernableByAdmin`, you can decide whether consuming tenant administrators of the application should be provided management capabilities on Microsoft-enabled administrator support, through SharePoint admin center and PowerShell. When not passed, the value is set to True. When set to False, the consuming tenant administrator can perform only read-only actions on containers of the container type, in both SharePoint admin center and PowerShell. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -122,13 +128,15 @@ Accept wildcard characters: False ### -IsPassThroughBilling +> Applicable: SharePoint Online + This parameter is used to create a direct to customer billed container type. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -139,13 +147,15 @@ Accept wildcard characters: False ### -OwningApplicationId +> Applicable: SharePoint Online + This parameter specifies the ID of the SharePoint Embedded application. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -156,13 +166,15 @@ Accept wildcard characters: False ### -TrialContainerType +> Applicable: SharePoint Online + This parameter is used to specify that the cmdlet is used to create a trial container type and thereby the billing profile need not be provided. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md index 3578dbd9c..aa2629acb 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md @@ -149,13 +149,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionExpirationReportJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionExpirationReportJob.md index 51ac9780a..220b61dd9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionExpirationReportJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionExpirationReportJob.md @@ -74,13 +74,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md index bf5e36dcf..ee50f5127 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md @@ -56,13 +56,15 @@ This example creates a new set of migration source package metadata files in the ### -IgnoreHidden +> Applicable: SharePoint Online + Switch to ignore hidden files and folders. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ### -IncludeFileSharePermissions +> Applicable: SharePoint Online + Used to include permissions and sharing information into the generated manifest files in the package metadata. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ### -NoAzureADLookup +> Applicable: SharePoint Online + Switch to not lookup local user accounts in Microsoft Entra ID. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -107,13 +113,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Used to not create a log file. The default is to create a new CreateMigrationPackage log file within the directory specified within the OutputPackagePath parameter. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -124,13 +132,15 @@ Accept wildcard characters: False ### -OutputPackagePath +> Applicable: SharePoint Online + The directory location where the output package metadata files will be saved. If the directory does not exist, it will be created. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -141,13 +151,15 @@ Accept wildcard characters: False ### -ReplaceInvalidCharacters +> Applicable: SharePoint Online + Switch to replace characters in file and folder names that would be invalid in SharePoint Online. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -158,13 +170,15 @@ Accept wildcard characters: False ### -SourceFilesPath +> Applicable: SharePoint Online + The directory location where the source content files exist. This directory will be enumerated to create the package metadata files. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -175,13 +189,15 @@ Accept wildcard characters: False ### -TargetDocumentLibraryPath +> Applicable: SharePoint Online + The web relative document library to use as the document library part of the base URL in the package metadata. If this is not supplied, "Documents" will be used within the package metadata instead. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 3 @@ -192,13 +208,15 @@ Accept wildcard characters: False ### -TargetDocumentLibrarySubFolderPath +> Applicable: SharePoint Online + Specifies the document library relative subfolder to use as the folder path part of the base URL in the package metadata. If this is not provided, no value will be used within the package metadata. The files will be homed under the document library root. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 4 @@ -209,13 +227,15 @@ Accept wildcard characters: False ### -TargetWebUrl +> Applicable: SharePoint Online + The fully qualified web URL to use as the web address part of the base URL in the package metadata. If this is not provided, "`https://fileserver/sites/user`" will be used instead within the package metadata. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 2 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md index 4d89d6d69..28dbdeaca 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md @@ -40,13 +40,15 @@ This example shows how to you can setup a new Public CDN on a document library i ### -Url +> Applicable: SharePoint Online + Specify the URL that will be enabled for Public CDN in your tenant ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -74,6 +78,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -81,7 +87,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md index 683437283..8fa4413d5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md @@ -40,13 +40,15 @@ This example creates the Hive for a SDN Provider. ### -Identity +> Applicable: SharePoint Online + Identity of the provider. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -License +> Applicable: SharePoint Online + License key provided by the provider. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -74,13 +78,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -91,6 +97,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -98,7 +106,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md index 35f05a55f..319ae2ad8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md @@ -63,13 +63,15 @@ Example 3 creates a new site collection for the current company with specified s ### -CompatibilityLevel +> Applicable: SharePoint Online + This parameter no longer has any effect and only accepts a value of '15'. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -95,13 +97,15 @@ Accept wildcard characters: False ### -LocaleId +> Applicable: SharePoint Online + Specifies the language of this site collection. For more information, see Locale IDs Assigned by Microsoft (). The Template and LocaleId parameters must be a valid combination as returned from the `Get-SPOWebTemplate` cmdlet. ```yaml Type: System.UInt32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -112,13 +116,15 @@ Accept wildcard characters: False ### -NoWait +> Applicable: SharePoint Online + Specifies to continue executing script immediately. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -129,13 +135,15 @@ Accept wildcard characters: False ### -Owner +> Applicable: SharePoint Online + Specifies the user name of the site collection's primary owner. The owner must be a email-enabled user instead of a security group or an email-enabled security group. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -146,13 +154,15 @@ Accept wildcard characters: False ### -ResourceQuota +> Applicable: SharePoint Online + Specifies the quota for this site collection in Sandboxed Solutions units. This value must not exceed the company's aggregate available Sandboxed Solutions quota. The default value is 0. For more information, see [Resource Usage Limits on Sandboxed Solutions in SharePoint](/previous-versions/office/developer/sharepoint-2010/gg615462(v=office.14)). Note that this parameter is now obsolete and has been deprecated. ```yaml Type: System.Double Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -163,13 +173,15 @@ Accept wildcard characters: False ### -StorageQuota +> Applicable: SharePoint Online + Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. ```yaml Type: System.Int64 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -180,13 +192,15 @@ Accept wildcard characters: False ### -Template +> Applicable: SharePoint Online + Specifies the site collection template type. Use the `Get-SPOWebTemplate` cmdlet to get the list of valid templates. If no template is specified, one can be added later. The Template and LocaleId parameters must be a valid combination as returned from the `Get-SPOWebTemplate` cmdlet. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -197,13 +211,15 @@ Accept wildcard characters: False ### -TimeZoneId +> Applicable: SharePoint Online + Specifies the time zone of the site collection. For more information, see [RegionalSettings.TimeZones property](/previous-versions/office/sharepoint-csom/jj171282(v=office.15)). ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -214,13 +230,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + Specifies the title of the site collection. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -231,13 +249,15 @@ Accept wildcard characters: False ### -Url +> Applicable: SharePoint Online + Specifies the full URL of the new site collection. It must be in a valid managed path in the company's site. For example, for company contoso, valid managed paths are and ```yaml Type: Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionBatchDeleteJob.md index a8424cde7..c3457ff37 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionBatchDeleteJob.md @@ -103,13 +103,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionExpirationReportJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionExpirationReportJob.md index 5d5620a0b..34b878f76 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionExpirationReportJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionExpirationReportJob.md @@ -42,13 +42,15 @@ Example 1 starts generating file version expiration report on for the site colle ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md index 63fc08ddb..ad2a441b4 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md @@ -53,13 +53,15 @@ This example creates a group named NewGroupName with the Design permission level ### -Group +> Applicable: SharePoint Online + Specifies the name of the group to add. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -70,6 +72,8 @@ Accept wildcard characters: False ### -PermissionLevels +> Applicable: SharePoint Online + Specifies the permission levels to grant to the newly created group. It can be any permission level that exists on the site collection on which the group is being created. > [!NOTE] @@ -79,7 +83,7 @@ Specifies the permission levels to grant to the newly created group. It can be a Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the site collection to add the group to. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteSharingReportJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteSharingReportJob.md index 0009b13ab..b3a7f3e4a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteSharingReportJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteSharingReportJob.md @@ -40,13 +40,15 @@ New-SPOSiteSharingReportJob -Site $site -ReportStorageWebUrl 'https://contoso.sh ### -ReportStorageFolderUrl +> Applicable: SharePoint Online + Location to where the report will be exported. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 Default value: None @@ -56,13 +58,15 @@ Accept wildcard characters: False ### -ReportStorageWebUrl +> Applicable: SharePoint Online + Report web storage URL. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -72,13 +76,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md index cf162de9e..9ac95dc76 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md @@ -50,13 +50,15 @@ This example registers the DEP used with SharePoint Online and OneDrive for Busi ### -PrimaryKeyName +> Applicable: SharePoint Online + The name of the primary key ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -66,13 +68,15 @@ Accept wildcard characters: False ### -PrimaryKeyVaultName +> Applicable: SharePoint Online + The name of the primary key vault ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -97,13 +101,15 @@ Accept wildcard characters: False ### -PrimaryKeyVersion +> Applicable: SharePoint Online + The version of the primary key ```yaml Type: System.Guid Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -113,13 +119,15 @@ Accept wildcard characters: False ### -SecondaryKeyName +> Applicable: SharePoint Online + The name of the secondary key ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -129,13 +137,15 @@ Accept wildcard characters: False ### -SecondaryKeyVaultName +> Applicable: SharePoint Online + The name of the secondary key vault ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -160,13 +170,15 @@ Accept wildcard characters: False ### -SecondaryKeyVersion +> Applicable: SharePoint Online + The version of the secondary key ```yaml Type: System.Guid Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -175,13 +187,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Online Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -191,13 +205,15 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md index 3d0988566..8b50b1dae 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md @@ -45,13 +45,15 @@ This example registers the marketing site on Contoso as hub site without setting ### -Principals +> Applicable: SharePoint Online + Specifies one or more principals (user or group) to be granted rights to the specified HubSite. Can be used to filter who can associate sites to this hub site. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -62,13 +64,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site collection to which to enable the hub site features. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md index 6ed67e914..45ff35539 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md @@ -50,13 +50,15 @@ Remove-SPOAppBillingPolicy -ApplicationId 1653hhd-87100luhw-786265gk-00asa00 ### -ApplicationID +> Applicable: SharePoint Online + This parameter specifies the ID of the application. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md index ebed707ca..a5f8ed97b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md @@ -58,13 +58,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + Use this parameter to provide the `ContainerId` of the Container to be deleted. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md index 80b2067fd..7fc1dafa1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md @@ -42,13 +42,15 @@ Example 1 places the container with the given ID into the recycle bin. The conta ### -ContainerTypeId +> Applicable: SharePoint Online + This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. Use the `Get-SPOContainertype` command to retrieve the ID. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentEventEmailAddresses.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentEventEmailAddresses.md index 35db0fd56..ae21bb97c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentEventEmailAddresses.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentEventEmailAddresses.md @@ -42,6 +42,8 @@ In Example 1, the email addresses joe.doe@contoso.com and john.dow@contoso.com h ### -Category +> Applicable: SharePoint Online + Specifies the content event category. ```yaml @@ -49,7 +51,7 @@ Type: Microsoft.SharePoint.Administration.TenantAdmin.ContentEventCategory Parameter Sets: (All) Aliases: Accepted values: Unknown, Ransomware, HighVolumeDownload, HighVolumeDelete, HighVolumeShare -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md index 9470712ed..c0a1d0788 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md @@ -25,20 +25,22 @@ Remove-SPOContentSecurityPolicy [-Source] [-WhatIf] [-Confirm] [ Applicable: SharePoint Online + Source to be removed from the **Content Security Policy** configuration. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md index 26b4f687a..4b919d72c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md @@ -66,13 +66,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + Specifies the `` of the Container to be permanently deleted. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md index 883b4f0d0..abbf6ced7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md @@ -46,13 +46,15 @@ This example removes a SharePoint Online deleted site collection named Applicable: SharePoint Online + Specifies the URL of the site collection to remove. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ### -NoWait +> Applicable: SharePoint Online + Continues without the status being polled. Polling the action can slow its progress. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -80,13 +84,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -97,6 +103,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -104,7 +112,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md index c20ad0360..dd20edf6f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOExternalUser.md @@ -45,13 +45,15 @@ This example removes a specific external user who has the address "someone@examp ### -UniqueIDs +> Applicable: SharePoint Online + Specifies an ID that can be used to identify an external user based on their Windows Live ID. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -61,13 +63,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -77,6 +81,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -84,7 +90,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md index 6abd35a60..ed7cba40b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md @@ -96,13 +96,15 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + +> Applicable: SharePoint Online {{ Fill UserPrincipalName Description }} ```yaml Type: System.String Parameter Sets: User Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md index 177fe4c3f..ad85a7fb6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md @@ -45,13 +45,15 @@ This example removes the research site from the marketing hub site. ### -Site +> Applicable: SharePoint Online + URL of the site to remove from the hub site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubToHubAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubToHubAssociation.md index 708756248..445942bbc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubToHubAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubToHubAssociation.md @@ -40,13 +40,15 @@ This example removes the site with the given id from its parent Hub. ### -HubsiteId +> Applicable: SharePoint Online + Id of the Hub site to be removed from its parent Hub. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListFileVersionBatchDeleteJob.md index 69b06879a..5f2a0e98b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListFileVersionBatchDeleteJob.md @@ -58,13 +58,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md index 997773e59..7d5024379 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md @@ -41,13 +41,15 @@ This example removes the specified migration job from the site collection " Applicable: SharePoint Online + Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session's previous call to `Connect-SPOService` will be used to connect to the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -58,13 +60,15 @@ Accept wildcard characters: False ### -JobId +> Applicable: SharePoint Online + Id of a previously created migration job that exists on the target site collection. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -75,13 +79,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Indicates to not create a log file. The default is to create a new DeleteMigrationJob log file within the current directory. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -92,13 +98,15 @@ Accept wildcard characters: False ### -TargetWebUrl +> Applicable: SharePoint Online + The fully qualified URL of the site collection where the job will be deleted if found. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMultiGeoCompanyAllowedDataLocation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMultiGeoCompanyAllowedDataLocation.md index 40f2162f1..7c0545d52 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMultiGeoCompanyAllowedDataLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMultiGeoCompanyAllowedDataLocation.md @@ -39,13 +39,15 @@ Removes AUS (Australia) as an allowed mutli-geo location. ### -Location +> Applicable: SharePoint Online + The Preferred Data Location (PDL) to remove. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -55,6 +57,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -62,7 +66,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -71,6 +75,8 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -78,7 +84,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgAssetsLibrary.md index 9a784c0ed..1ea10045e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgAssetsLibrary.md @@ -43,13 +43,15 @@ Remove-SPOOrgAssetsLibrary -ListId 58454454-6546-6466-9769-646464623988 ### -LibraryUrl +> Applicable: SharePoint Online + Indicates the server relative URL of the library to be removed as a central location for organization assets. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -59,13 +61,15 @@ Accept wildcard characters: False ### -ListId +> Applicable: SharePoint Online + Indicates the library ID for the library to be removed as a central location for organization assets. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md index e24cdbf7f..02a678b88 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md @@ -39,13 +39,15 @@ This example removes from the l ### -OrgNewsSiteUrl +> Applicable: SharePoint Online + The URL of a site to be marked as an organizational news site. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md index 8745a9338..62bd788e2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md @@ -47,13 +47,15 @@ This example returns a list of CDN origins and then removes an origin based on t ### -Identity +> Applicable: SharePoint Online + It's the unique identifier of the Public CDN path, it can be queried using the Cmdlet Get-SpoPublicCdnOrigins ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -64,13 +66,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -81,6 +85,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -88,7 +94,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md index f54ab5b88..4f47675e3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md @@ -48,13 +48,15 @@ This command will prompt for a confirmation before "simulating" that it will rem ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -65,6 +67,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -72,7 +76,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md index ef6decb0b..399de75ac 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md @@ -47,13 +47,15 @@ This example immediately removes the site collection named Applicable: SharePoint Online + Specifies the URL of the site collection to remove. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ### -NoWait +> Applicable: SharePoint Online + Specifies to continue executing script immediately. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -81,13 +85,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -98,6 +104,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -105,7 +113,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalog.md index 9b57f0286..9d5bcffa1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalog.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalog.md @@ -40,13 +40,15 @@ This example removes the site collection app catalog from the site Applicable: SharePoint Online + Url of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalogById.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalogById.md index 89fed96cd..a5590a72e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalogById.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteCollectionAppCatalogById.md @@ -40,13 +40,15 @@ This example removes the site collection app catalog from the site with the id ' ### -SiteId +> Applicable: SharePoint Online + Guid of the site collection. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesign.md index 0eadd70f3..8639c352f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesign.md @@ -44,13 +44,15 @@ Remove-SPOSiteDesign 21209d88-38de-4844-9823-f1f600a1179a ### -Identity +> Applicable: SharePoint Online + The ID of the site design to remove. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesignTask.md index 2ab865873..d04098096 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesignTask.md @@ -43,13 +43,15 @@ Remove-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 ### -Identity +> Applicable: SharePoint Online + The ID of the site design to apply. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteFileVersionBatchDeleteJob.md index f424a8419..97e54b035 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteFileVersionBatchDeleteJob.md @@ -43,13 +43,15 @@ Example 1 cancels further processing of the trim job for the site collection. ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md index 717269015..ea91a2fab 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md @@ -44,13 +44,15 @@ This example removes a group named GroupToRemove from the site collection Applicable: SharePoint Online + Specifies the name of the group to remove. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -61,13 +63,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the site collection to remove the group from. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteScript.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteScript.md index 7bf3b4f1a..0cbaf0f5a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteScript.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteScript.md @@ -40,13 +40,15 @@ Removes a site script. ### -Identity +> Applicable: SharePoint Online + The ID of the site script to remove. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteUserInvitations.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteUserInvitations.md index 13d936270..869b34a00 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteUserInvitations.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteUserInvitations.md @@ -41,11 +41,13 @@ This example removes the user with the mail address "someone@contoso.com" from t ### -CountOnly +> Applicable: SharePoint Online + ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 3 Default value: None @@ -55,13 +57,15 @@ Accept wildcard characters: False ### -EmailAddress +> Applicable: SharePoint Online + Email Address of the user. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 Default value: None @@ -71,13 +75,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteVersionPolicyJob.md index 524e3b5d8..928637fba 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteVersionPolicyJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteVersionPolicyJob.md @@ -41,13 +41,15 @@ Example 1 cancels further processing of the job that sets version policy for exi ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOStorageEntity.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOStorageEntity.md index 2ec8d3b6e..dd6d96e3a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOStorageEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOStorageEntity.md @@ -41,13 +41,15 @@ This example removes the value of my custom value. ### -Key +> Applicable: SharePoint Online + The key in the property bag that should be removed. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + URL to the tenant or site collection app catalog. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md index d0c782454..a5969085f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md @@ -57,6 +57,8 @@ This example removes a recently-removed organizational assets library from a CDN ### -CdnType +> Applicable: SharePoint Online + Specifies the CDN type. The valid values are: Public or Private. ```yaml @@ -64,7 +66,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private -Applicable: SharePoint Online + Required: True Position: Named @@ -75,6 +77,8 @@ Accept wildcard characters: False ### -OriginUrl +> Applicable: SharePoint Online + Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. Relative-Relative path depends on the OriginScope. If the originScope is Tenant, a path must be a relative path under the tenant root. If the originScope is Site, a path must be a relative path under the given Site. The path must point to the valid Document Library or a folder with a document library. @@ -87,7 +91,7 @@ Mask - Mask allows to configure a partial URL match. It must start with */, and Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -98,13 +102,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -115,6 +121,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -122,7 +130,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md index bd522d194..5dace112d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md @@ -42,13 +42,15 @@ This example removes a user who has the email address joe.healy@contoso.com from ### -Group +> Applicable: SharePoint Online + Specifies the group to remove the user from. If not specified, the cmdlet removes the user from all groups. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ### -LoginName +> Applicable: SharePoint Online + Specifies the user name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -76,13 +80,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the site collection to remove the user from. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md index e908ae310..7f0933ca2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md @@ -32,13 +32,15 @@ Do not use. ### -LoginName +> Applicable: SharePoint Online + Do not use. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -64,13 +66,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Do not use. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md index 2f952cfda..427a93bb3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md @@ -44,13 +44,15 @@ Example 1 removes a user who has the e-mail address joe.healy@contoso.com from t ### -LoginName +> Applicable: SharePoint Online + Specifies the login name of the user which user profile is deleted. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md index ebf622556..f9173b043 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md @@ -58,13 +58,15 @@ This example runs the Missing Galleries Check rule in repair mode on the Applicable: SharePoint Online + Specifies the SharePoint Online site collection on which to run the repairs. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -75,6 +77,8 @@ Accept wildcard characters: False ### -RuleId +> Applicable: SharePoint Online + Specifies a health check rule to run. For example: @@ -90,7 +94,7 @@ For example: Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -101,13 +105,15 @@ Accept wildcard characters: False ### -RunAlways +> Applicable: SharePoint Online + Displays a message that explains the effect of the command instead of executing the command. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -118,13 +124,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -135,6 +143,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -142,7 +152,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md index 846e22eb0..016ad9c7e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOPersonalSite.md @@ -57,13 +57,15 @@ This example requests that many users to be queued for the creation of a Persona ### -NoWait +> Applicable: SharePoint Online + Continues without the status being polled. Polling the action can slow it's progress if lots of user emails are specified. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -74,6 +76,8 @@ Accept wildcard characters: False ### -UserEmails +> Applicable: SharePoint Online + Specifies one or more user logins to be enqueued for the creation of a Personal Site. The Personal site is created by a Timer Job later. You can specify between 1 and 200 users. > [!NOTE] > If you're pre-provisioning OneDrive for a large number of users, it might take multiple days for the OneDrive locations to be created. @@ -82,7 +86,7 @@ Specifies one or more user logins to be enqueued for the creation of a Personal Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md index 4a52a5c3d..195ccc402 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md @@ -56,13 +56,15 @@ This example requests a site upgrade evaluation for the marketing site Applicable: SharePoint Online + Specifies the SharePoint Online site collection for which you want to request a copy for the new Upgrade or Evaluation site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -73,13 +75,15 @@ Accept wildcard characters: False ### -NoEmail +> Applicable: SharePoint Online + Specifies that the system not send the requester and site collection administrators an email message at the end of the upgrade evaluation site creation process. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -90,13 +94,15 @@ Accept wildcard characters: False ### -NoUpgrade +> Applicable: SharePoint Online + Specifies that the system not perform an upgrade as part of the evaluation site creation process. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -107,13 +113,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -124,6 +132,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -131,7 +141,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODataEncryptionPolicy.md index 022c1e640..a0c1daa87 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODataEncryptionPolicy.md @@ -49,13 +49,15 @@ This example restores the DEP used with SharePoint Online and OneDrive for Busin ### -PrimaryKeyName +> Applicable: SharePoint Online + The name of the primary key. ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -65,13 +67,15 @@ Accept wildcard characters: False ### -PrimaryKeyVaultName +> Applicable: SharePoint Online + The name of the primary key vault. ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -96,13 +100,15 @@ Accept wildcard characters: False ### -PrimaryKeyVersion +> Applicable: SharePoint Online + The version of the primary key. ```yaml Type: System.Guid Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -112,13 +118,15 @@ Accept wildcard characters: False ### -SecondaryKeyName +> Applicable: SharePoint Online + The name of the secondary key. ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -128,13 +136,15 @@ Accept wildcard characters: False ### -SecondaryKeyVaultName +> Applicable: SharePoint Online + The name of the secondary key vault. ```yaml Type: System.String Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -159,13 +169,15 @@ Accept wildcard characters: False ### -SecondaryKeyVersion +> Applicable: SharePoint Online + The version of the secondary key. ```yaml Type: System.Guid Parameter Sets: BYOK_MultipleParameters Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md index 6a5af8567..18046ecb1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md @@ -44,13 +44,15 @@ Example 1 restores the Container with `ContainerId` `b66f5b2e-4cbd-4754-9ad3-829 ### -Identity +> Applicable: SharePoint Online + Use this parameter to specify the `ContainerId` of the deleted container to be restored. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md index 1f6592a9b..d7fd241cd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md @@ -42,13 +42,15 @@ This example restores a SharePoint Online deleted site collection named " Applicable: SharePoint Online + Specifies the URL of the site collection to restore. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -59,13 +61,15 @@ Accept wildcard characters: False ### -NoWait +> Applicable: SharePoint Online + Specifies to continue executing script immediately. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md index ff1b47677..8faa56dcc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOHubSiteRights.md @@ -44,13 +44,15 @@ This example shows how to revoke rights so that Nestor can no longer join sites ### -Identity +> Applicable: SharePoint Online + URL of the hub site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite -Applicable: SharePoint Online + Required: True Position: 0 @@ -61,13 +63,15 @@ Accept wildcard characters: False ### -Principals +> Applicable: SharePoint Online + One or more principals to revoke the permissions for. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOSiteDesignRights.md index d7227f8b2..0744ebef2 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOSiteDesignRights.md @@ -41,13 +41,15 @@ Revoke-SPOSiteDesignRights 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` ### -Identity +> Applicable: SharePoint Online + The ID of the site design from which to revoke rights. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Principals +> Applicable: SharePoint Online + One or more principals to revoke rights on the specified site design. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md index b9b8f9632..b9e8ac87c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md @@ -66,13 +66,15 @@ This example signs out user1 in the Contoso tenancy from all devices without pro ### -User +> Applicable: SharePoint Online + Specifies a user name. For example, user1@contoso.com ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -83,13 +85,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -100,6 +104,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -107,7 +113,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md index 6417dc282..e6a79a3ff 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md @@ -2,7 +2,7 @@ external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml Module Name: Microsoft.Online.SharePoint.PowerShell online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOApplication -Applicable: SharePoint Embedded + title: Set-SPOApplication schema: 2.0.0 author: ShreyasSar26 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md index 8e59e56bd..36eda3354 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md @@ -62,13 +62,15 @@ Example 3 sets guest application permissions to None for the guest application w ### -ApplicationId +> Applicable: SharePoint + Use this parameter to specify the guest application ID. A guest application is any application within the tenant's enterprise applications. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint + Required: True Position: 1 @@ -79,13 +81,15 @@ Accept wildcard characters: False ### -OwningApplicationId +> Applicable: SharePoint + Use this parameter to specify the Owning Application where guest application access is granted. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint + Required: True Position: 0 @@ -96,13 +100,15 @@ Accept wildcard characters: False ### -PermissionAppOnly +> Applicable: SharePoint + Use this parameter to specify the app-only permissions of the guest application. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint + Required: True Position: 2 @@ -113,13 +119,15 @@ Accept wildcard characters: False ### -PermissionDelegated +> Applicable: SharePoint + This parameter specifies delegated permissions which are not supported for guest applications at this time. ```yaml Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint + Required: False Position: 3 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBrowserIdleSignOut.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBrowserIdleSignOut.md index 5c63d60aa..fc7db90d0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBrowserIdleSignOut.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBrowserIdleSignOut.md @@ -49,13 +49,15 @@ This example enables the browser idle sign-out policy, sets a warning at 45 minu ### -Enabled +> Applicable: SharePoint Online + Enables the browser idle sign-out policy ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md index 1cdd3a578..54762582d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md @@ -100,13 +100,15 @@ Set-SPOBuiltInSiteTemplateSettings -Identity "00000000-0000-0000-0000-0000000000 ### -Identity +> Applicable: SharePoint Online + Specifies the ID for the site template you wish to change. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOBuiltInSiteTemplateSettingsPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -116,13 +118,15 @@ Accept wildcard characters: False ### -IsHidden +> Applicable: SharePoint Online + Specifies whether the site template is hidden ($true) or displayed ($false). All site templates are displayed by default. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md index 08d9681f1..74c4383cf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md @@ -2,7 +2,7 @@ external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml Module Name: Microsoft.Online.SharePoint.PowerShell online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOContainer -Applicable: SharePoint Embedded + title: Set-SPOContainer schema: 2.0.0 author: ShreyasSar26 @@ -127,6 +127,8 @@ Accept wildcard characters: False ### -BlockDownloadPolicy + +> Applicable: SharePoint Embedded As a SharePoint Embedded Administrator, you can block the download of files from SharePoint Embedded containers. This feature does not need Microsoft Entra Conditional Access policies. This feature can be set for individual containers but not at the organization level. Blocking the download of files allows users to remain productive while addressing the risk of accidental data loss. Users have browser-only access with no ability to download, print, or sync files. They also won't be able to access content through apps, including the Microsoft Office desktop apps. When web access is limited, users will see the following message at the top of containers: "Your organization doesn't allow you to download, print, or sync from this Container. For help contact your IT department." Read the full documentation for advanced capabilities at [Block download policy for SharePoint Containers and OneDrive](/sharepoint/block-download-from-sites). @@ -135,7 +137,7 @@ Blocking the download of files allows users to remain productive while addressin Type: System.Boolean Parameter Sets: BlockDownloadPolicy Aliases: -Applicable: SharePoint Embedded + Required: False Position: Named Default value: None @@ -144,6 +146,8 @@ Accept wildcard characters: False ``` ### -ConditionalAccessPolicy + +> Applicable: SharePoint Embedded Read the [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices) documentation to understand Conditional Access Policy usage in SharePoint Embedded container. Possible values: @@ -156,7 +160,7 @@ Type: Microsoft.Online.SharePoint.TenantManagement.SPOConditionalAccessPolicyTyp Parameter Sets: ConditionalAccess Aliases: Accepted values: AllowFullAccess, AllowLimitedAccess, BlockAccess, AuthenticationContext -Applicable: SharePoint Embedded + Required: False Position: Named Default value: None @@ -262,13 +266,15 @@ Accept wildcard characters: False ``` ### -SensitivityLabel + +> Applicable: SharePoint Embedded Specifies the unique identifier (GUID) of the SensitivityLabel. ```yaml Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Embedded + Required: False Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md index f3d12260f..82e42908c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md @@ -152,6 +152,8 @@ Accept wildcard characters: False ### -DiscoverabilityDisabled +> Applicable: SharePoint Embedded + As a SharePoint Administrator in Microsoft 365, you can control how your content appears in the Microsoft 365 experience. When this value is true, the SharePoint Embedded application content is hidden throughout the Microsoft 365 environment, including on office.com, onedrive.com, in recommended sections, or through other Microsoft intelligent file discovery features. If you opt into the Microsoft 365 experience, your files will be integrated into Microsoft 365 environment, participating in intelligent file discovery. @@ -161,7 +163,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Embedded + Required: False Position: Named Default value: None @@ -207,6 +209,8 @@ Accept wildcard characters: False ### -SharingRestricted +> Applicable: SharePoint Embedded + SharePoint Embedded offers a role-based sharing model that allows developers to configure file-sharing permissions based on container permission roles, offering a choice between a restrictive and an open sharing model. The open sharing model allows any container members and guest users with edit permissions to share files. The restrictive sharing model allows only container members who are either Owners or Managers to share files. PARAMVALUE: True | False @@ -215,7 +219,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Embedded + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContentEventEmailAddresses.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContentEventEmailAddresses.md index 5648c64c5..90e7d1637 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContentEventEmailAddresses.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContentEventEmailAddresses.md @@ -42,6 +42,8 @@ In Example 1, the email addresses joe.doe@contoso.com and john.dow@contoso.com h ### -Category +> Applicable: SharePoint Online + Specifies the content event category. ```yaml @@ -49,7 +51,7 @@ Type: Microsoft.SharePoint.Administration.TenantAdmin.ContentEventCategory Parameter Sets: (All) Aliases: Accepted values: Unknown, Ransomware, HighVolumeDownload, HighVolumeDelete, HighVolumeShare -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md index fb9b6fa0b..b18bd375c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md @@ -38,13 +38,15 @@ Example 1 sets the Opt-In Copilot promo status for the tenant to `True`. ## PARAMETERS ### -IsCopilotPromoStatusEnabled + +> Applicable: SharePoint Online Use this parameter to set Copilot opt-in promo status. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md index 9f6919fba..4bee3c2b3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md @@ -40,13 +40,15 @@ This cmdlet sends a trust request to the Contoso tenant. ## PARAMETERS ### -PartnerCrossTenantHostUrl + +> Applicable: SharePoint Online The cross-tenant URL of the partner tenant. The partner tenant can determine this for you by running `Get-SPOCrossTenantHostUrl` on each of the tenants. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 @@ -56,6 +58,8 @@ Accept wildcard characters: False ``` ### -PartnerRole + +> Applicable: SharePoint Online Roles of the partner tenant you're establishing trust with. Use *source* if the partner tenant is the source of the OneDrive migrations, and *target* if the partner tenant is the destination. ```yaml @@ -63,7 +67,7 @@ Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole Parameter Sets: (All) Aliases: Accepted values: None, Source, Target -Applicable: SharePoint Online + Required: True Position: 1 @@ -74,12 +78,14 @@ Accept wildcard characters: False ### -Scenario +> Applicable: SharePoint Online + ```yaml Type: Microsoft.SharePoint.Client.Administration.OrgRelationScenario Parameter Sets: (All) Aliases: Accepted values: None, MnA -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md index 226ecc9b8..8c81f48e5 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md @@ -48,13 +48,15 @@ Sets the SharePoint Online Storage Quota on the **NORTH CENTRAL US** location to ### -GeoLocation +> Applicable: SharePoint Online + The desired Geo Location to set. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -65,13 +67,15 @@ Accept wildcard characters: False ### -StorageQuotaMB +> Applicable: SharePoint Online + SharePoint Online Storage Quota in MegaBytes. ```yaml Type: System.Int64 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md index ce694919a..a6a547413 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md @@ -47,13 +47,15 @@ This example updates the name of the hub displayed in the SharePoint user interf ### -Description +> Applicable: SharePoint Online + A description of the hub site. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -94,13 +96,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + URL of the hub site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite -Applicable: SharePoint Online + Required: True Position: 0 @@ -111,13 +115,15 @@ Accept wildcard characters: False ### -LogoUrl +> Applicable: SharePoint Online + The URL of a logo to use in the hub navigation. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -128,13 +134,15 @@ Accept wildcard characters: False ### -RequiresJoinApproval +> Applicable: SharePoint Online + Determines if joining a Hub site requires approval. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -145,13 +153,15 @@ Accept wildcard characters: False ### -SiteDesignId +> Applicable: SharePoint Online + Site Design ID, for example db752673-18fd-44db-865a-aa3e0b28698e ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -162,13 +172,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + The display name of the hub. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOListVersionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOListVersionPolicy.md index fbf27911f..095fa9c5b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOListVersionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOListVersionPolicy.md @@ -56,6 +56,8 @@ Example 3 sets manual version histroy limits on the document library called "Doc ## PARAMETERS ### -EnableAutoExpirationVersionTrim + +> Applicable: SharePoint Online Global and SharePoint Administrators can set document library level version history limits settings that universally apply to new versions created. When version history limits are managed automatically, SharePoint employs an algorithm behind the scenes that deletes (thins out) intermittent older versions that are least likely to be needed, while preserving sufficient high-value versions - more versions in the recent past and fewer farther back in time - in case restores are required. @@ -78,7 +80,7 @@ PARAMVALUE: $true | $false Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -87,6 +89,8 @@ Accept wildcard characters: False ``` ### -ExpireVersionsAfterDays + +> Applicable: SharePoint Online When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), admins will need to set the limits to the number of major versions (`MajorVersionLimit`), the number of major with minor versions (`MajorWithMinorVersionsLimit`) and the time period the versions are stored (`ExpireVersionsAfterDays`). Please check the description of `EnableAutoExpirationVersionTrim` for more details. PARAMVALUE: Int32 @@ -95,7 +99,7 @@ PARAMVALUE: Int32 Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -120,6 +124,8 @@ Accept wildcard characters: False ``` ### -MajorVersionLimit + +> Applicable: SharePoint Online When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), admins will need to set the limits to the number of major versions (`MajorVersionLimit`) and the time period the versions are stored (`ExpireVersionsAfterDays`). Please check the description of `EnableAutoExpirationVersionTrim` for more details. PARAMVALUE: Int32 @@ -128,7 +134,7 @@ PARAMVALUE: Int32 Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -137,6 +143,8 @@ Accept wildcard characters: False ``` ### -MajorWithMinorVersionsLimit + +> Applicable: SharePoint Online When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), admins will need to set the limits to the number of major versions (`MajorVersionLimit`), the number of major with minor versions (`MajorWithMinorVersionsLimit`) and the time period the versions are stored (`ExpireVersionsAfterDays`). Please check the description of `EnableAutoExpirationVersionTrim` for more details. PARAMVALUE: Int32 @@ -145,7 +153,7 @@ PARAMVALUE: Int32 Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -155,13 +163,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the URL of the site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md index af7ee384e..e33422223 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md @@ -82,13 +82,15 @@ This example uses existing migration package containers in Azure storage to snap ### -AccountKey +> Applicable: SharePoint Online + The account key for the Azure Storage account. ```yaml Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -98,13 +100,15 @@ Accept wildcard characters: False ### -AccountName +> Applicable: SharePoint Online + The account name for the Azure Storage account. ```yaml Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -114,13 +118,15 @@ Accept wildcard characters: False ### -AzureQueueName +> Applicable: SharePoint Online + An optional name of the Azure Storage Reporting Queue where import operations lists events during import. This value must be in lower case and conform to Azure's queue naming rules. ```yaml Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -130,13 +136,15 @@ Accept wildcard characters: False ### -EncryptionMetaInfo +> Applicable: SharePoint Online + PARAMVALUE: MigrationFileEncryptionInfo[] ```yaml Type: Microsoft.Online.SharePoint.Migration.MigrationFileEncryptionInfo[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -146,13 +154,15 @@ Accept wildcard characters: False ### -EncryptionParameters +> Applicable: SharePoint Online + An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. ```yaml Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -163,13 +173,15 @@ Accept wildcard characters: False ### -FileContainerName +> Applicable: SharePoint Online + The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package content files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format \-files. ```yaml Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -179,13 +191,15 @@ Accept wildcard characters: False ### -MigrationPackageAzureLocations +> Applicable: SharePoint Online + A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the `Set-SPOMigrationPackageAzureSource` ```yaml Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: ImplicitSourceImplicitAzure, ExplicitSourceImplicitAzure Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -195,13 +209,15 @@ Accept wildcard characters: False ### -MigrationSourceLocations +> Applicable: SharePoint Online + Possible Source locations to migrate. ```yaml Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceExplicitAzure, ImplicitSourceImplicitAzure Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -211,13 +227,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Indicates to not create a log file. The default is to create a new CopyMigrationPackage log file within the directory specified within the SourcePackagePath parameter. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -227,13 +245,15 @@ Accept wildcard characters: False ### -NoSnapshotCreation +> Applicable: SharePoint Online + Indicates to not perform snapshots on the content in the containers. The default is to snapshot each of the packages files in the containers. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -243,13 +263,15 @@ Accept wildcard characters: False ### -NoUpload +> Applicable: SharePoint Online + Indicates to not upload the package files. The default is to upload all the package files. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -259,11 +281,13 @@ Accept wildcard characters: False ### -Overwrite +> Applicable: SharePoint Online + ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -273,13 +297,15 @@ Accept wildcard characters: False ### -PackageContainerName +> Applicable: SharePoint Online + The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package metadata files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format \-package. ```yaml Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -304,13 +330,15 @@ Accept wildcard characters: False ### -SourceFilesPath +> Applicable: SharePoint Online + The directory location where the package's source content files exist. ```yaml Type: System.String Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -320,13 +348,15 @@ Accept wildcard characters: False ### -SourcePackagePath +> Applicable: SharePoint Online + The directory location where the package's metadata files exist. ```yaml Type: System.String Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoCompanyAllowedDataLocation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoCompanyAllowedDataLocation.md index 8eed3735a..42191f949 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoCompanyAllowedDataLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoCompanyAllowedDataLocation.md @@ -41,13 +41,15 @@ Sets AUS (Australia) as an allowed multi-geo location for the domain contoso.com ### -InitialDomain +> Applicable: SharePoint Online + Sets the initial domain to associate with the specified data location. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Location +> Applicable: SharePoint Online + The Preferred Data Location (PDL) to allow. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -73,6 +77,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -80,7 +86,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -89,6 +95,8 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -96,7 +104,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoExperience.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoExperience.md index f12b0019b..83a4c333c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoExperience.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoExperience.md @@ -40,13 +40,15 @@ This example will upgrade your instance's multi-geo experience to include ShareP ### -AllInstances +> Applicable: SharePoint Online + . ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -56,6 +58,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -63,7 +67,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -72,6 +76,8 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -79,7 +85,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgAssetsLibrary.md index 5d8c5c0d6..60561876e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgAssetsLibrary.md @@ -81,13 +81,15 @@ Accept wildcard characters: False ### -LibraryUrl +> Applicable: SharePoint Online + Indicates the server relative URL of the library to be modified. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -97,6 +99,8 @@ Accept wildcard characters: False ### -OrgAssetType +> Applicable: SharePoint Online + Indicates the type of content in this library. Currently supported values are "ImageDocumentLibrary" and "OfficeTemplateLibrary". ImageDocumentLibrary is the default OrgAssetType and is best used for images. You can access the contents of this library from any site or page in the SharePoint filepicker. @@ -108,7 +112,7 @@ In order to benefit from both UIs you can choose "ImageDocumentLibrary,OfficeTem Type: Microsoft.Online.SharePoint.PowerShell.OrganizationAssetType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Accepted values: ImageDocumentLibrary, OfficeTemplateLibrary, OfficeFontLibrary, BrandKitLibrary Required: False Position: Named @@ -119,13 +123,15 @@ Accept wildcard characters: False ### -ThumbnailUrl +> Applicable: SharePoint Online + Indicates the URL of the background image used when the library is publicly displayed. If no thumbnail URL is indicated, the card will have a gray background. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md index 982123758..f36bf3941 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md @@ -41,13 +41,15 @@ This example marks as an organi ### -OrgNewsSiteUrl +> Applicable: SharePoint Online + The URL of a site to be marked as an organizational news site. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md index 44ef1b210..71e2a912d 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md @@ -76,6 +76,8 @@ Example 5 clears the policy for the `OneDrive` site type so that it no longer ap ### -Enabled +> Applicable: SharePoint Online + PARAMVALUE: true | false Enables or disables Restricted Site Creation feature in tenant. @@ -83,7 +85,7 @@ Enables or disables Restricted Site Creation feature in tenant. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -93,6 +95,8 @@ Accept wildcard characters: False ### -Mode +> Applicable: SharePoint Online + Specifies whether policies allow or deny users from creating sites. PARAMVALUE: Deny | Allow - Deny – a user will be blocked from creating a site if any policy applies to them. @@ -106,7 +110,7 @@ Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCre Parameter Sets: (All) Aliases: Accepted values: Deny, Allow -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -116,6 +120,8 @@ Accept wildcard characters: False ### -RestrictedSiteCreationGroups +> Applicable: SharePoint Online + A comma-separated list of up to 10 Microsoft Entra security group IDs. When paired with the `–SiteType` parameter, defines a new policy which applies to the specified groups. Set to the empty string ("") to clear the policy for a site type. @@ -123,7 +129,7 @@ Set to the empty string ("") to clear the policy for a site type. Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -133,6 +139,8 @@ Accept wildcard characters: False ### -SiteType +> Applicable: SharePoint Online + When paired with the `–RestrictedSiteCreationGroups` parameter, creates a new policy which applies to the specified types of sites. PARAMVALUE: All | SharePoint | OneDrive | Team | Communication @@ -148,7 +156,7 @@ Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCre Parameter Sets: (All) Aliases: Accepted values: All, SharePoint, OneDrive, Team, Communication -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md index 05993d6d0..c64338d21 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md @@ -339,13 +339,15 @@ Accept wildcard characters: False ### -AddRestrictedAccessControlGroups +> Applicable: SharePoint Online + Specifies the IDs of groups to be added to an access restriction policy and gain access. ```yaml Type: System.Guid[] Parameter Sets: AddRestrictedAccessControlGroups Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -355,6 +357,8 @@ Accept wildcard characters: False ### -AllowDownloadingNonWebViewableFiles +> Applicable: SharePoint Online + Specifies if non web viewable files can be downloaded. PARAMVALUE: False | True @@ -363,7 +367,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -373,6 +377,8 @@ Accept wildcard characters: False ### -AllowEditing +> Applicable: SharePoint Online + Prevents users from editing Office files in the browser and copying and pasting Office file contents out of the browser window. PARAMVALUE: False | True @@ -381,7 +387,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -391,6 +397,8 @@ Accept wildcard characters: False ### -AllowFileArchive +> Applicable: SharePoint Online + This setting enables or disables the file archive feature for a SharePoint site. If this parameter is passed as true for a site and Microsoft 365 Archive is enabled at the tenant-level, then the site will allow file archive. PARAMVALUE: False | True @@ -401,7 +409,7 @@ If set to True, the feature will be enable. Feature is disabled by default. Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -412,6 +420,8 @@ Accept wildcard characters: False ### -AllowSelfServiceUpgrade +> Applicable: SharePoint Online + Determines whether site collection administrators can upgrade their site collections. PARAMVALUE: False | True @@ -420,7 +430,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -429,6 +439,8 @@ Accept wildcard characters: False ``` ### -AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled + +> Applicable: SharePoint Online Enables or disables web property bag updates. When `AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled` is set to `$true`, the web property bag can be updated even if the Add And Customize Pages right is denied on the site collection. PARAMVALUE: True | False @@ -437,7 +449,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -447,6 +459,8 @@ Accept wildcard characters: False ### -AnonymousLinkExpirationInDays +> Applicable: SharePoint Online + Specifies all anonymous/anyone links that have been created (or will be created) will expire after the set number of days. Only applies if OverrideTenantAnonymousLinkExpirationPolicy is set to true. The valid number should be between 1 and 730. To remove the expiration requirement, set the value to zero (0). @@ -455,7 +469,7 @@ The valid number should be between 1 and 730. To remove the expiration requireme Type: System.Int32 Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -465,13 +479,15 @@ Accept wildcard characters: False ### -ApplyToExistingDocumentLibraries +> Applicable: SharePoint Online + Create a job to apply the version history limits setting to existing document libraries. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: SetSiteFileVersionPolicy Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -481,13 +497,15 @@ Accept wildcard characters: False ### -ApplyToNewDocumentLibraries +> Applicable: SharePoint Online + Apply the version history limits setting to new document libraries. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: SetSiteFileVersionPolicy Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -497,6 +515,8 @@ Accept wildcard characters: False ### -AuthenticationContextAccessType +> Applicable: SharePoint Online + Controls whether Authentication Context Limited Access is enabled for a site. The valid values are: @@ -508,7 +528,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.SPOAuthenticationContextPolicyAccessType Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -518,13 +538,15 @@ Accept wildcard characters: False ### -AuthenticationContextName +> Applicable: SharePoint Online + The conditional access authentication context name. ```yaml Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -534,6 +556,8 @@ Accept wildcard characters: False ### -BlockDownloadLinksFileType +> Applicable: SharePoint Online + The valid values are: - WebPreviewableFiles @@ -547,7 +571,7 @@ The site's value is compared with the tenant level setting and the stricter one Type: Microsoft.Online.SharePoint.TenantManagement.BlockDownloadLinksFileTypes Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -557,6 +581,8 @@ Accept wildcard characters: False ### -BlockDownloadPolicy +> Applicable: SharePoint Online + As a SharePoint administrator in Microsoft 365, you can block the download of files from SharePoint sites or OneDrive. This feature does not need Microsoft Entra Conditional Access policies. This feature can be set for individual sites but not at the organization level. Blocking the download of files allows users to remain productive while addressing the risk of accidental data loss. Users have browser-only access with no ability to download, print, or sync files. They also won't be able to access content through apps, including the Microsoft Office desktop apps. When web access is limited, users will see the following message at the top of sites: "Your organization doesn't allow you to download, print, or sync from this site. For help contact your IT department." Read the full documentation for advanced capabilities at [Block download policy for SharePoint sites and OneDrive](/sharepoint/block-download-from-sites). @@ -567,7 +593,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -607,13 +633,15 @@ Accept wildcard characters: False ### -ClearRestrictedAccessControl +> Applicable: SharePoint Online + Clears the list of groups that are given access via an access restriction policy. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ClearRestrictedAccessControl Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -638,6 +666,8 @@ Accept wildcard characters: False ### -CommentsOnSitePagesDisabled +> Applicable: SharePoint Online + Use this parameter to disable Comments section on Site Pages. The parameter can't be used for Groups Site Collections. @@ -647,7 +677,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -657,6 +687,8 @@ Accept wildcard characters: False ### -ConditionalAccessPolicy +> Applicable: SharePoint Online + Please read [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices) documentation here to understand Conditional Access Policy usage in SharePoint Online. Possible values: @@ -670,7 +702,7 @@ Possible values: Type: Microsoft.Online.SharePoint.TenantManagement.SPOConditionalAccessPolicyType Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -680,6 +712,8 @@ Accept wildcard characters: False ### -DefaultLinkPermission +> Applicable: SharePoint Online + The default link permission for the site collection. To be replaced by DefaultShareLinkRole. PARAMVALUE: None | View | Edit @@ -692,7 +726,7 @@ PARAMVALUE: None | View | Edit Type: Microsoft.Online.SharePoint.TenantManagement.SharingPermissionType Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -702,6 +736,8 @@ Accept wildcard characters: False ### -DefaultLinkToExistingAccess +> Applicable: SharePoint Online + When set to TRUE, the DefaultSharingLinkType will be overriden and the default sharing link will a People with Existing Access link (which does not modify permissions). When set to FALSE (the default), the DefaultSharingLinkType parameter controls the default sharing link type. PARAMVALUE: False | True @@ -710,7 +746,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -735,6 +771,8 @@ Accept wildcard characters: False ### -DefaultShareLinkRole +> Applicable: SharePoint Online + The default share link role for the site collection. It replaces `DefaultLinkPermission`. The valid values are: @@ -749,7 +787,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -759,6 +797,8 @@ Accept wildcard characters: False ### -DefaultShareLinkScope +> Applicable: SharePoint Online + The default share link scope on the site. It replaces `DefaultSharingLinkType`. The valid values are: @@ -772,7 +812,7 @@ The valid values are: Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -782,6 +822,8 @@ Accept wildcard characters: False ### -DefaultSharingLinkType +> Applicable: SharePoint Online + The default link type for the site collection. To be replaced by DefaultShareLinkScope. PARAMVALUE: None | AnonymousAccess | Internal | Direct @@ -795,7 +837,7 @@ PARAMVALUE: None | AnonymousAccess | Internal | Direct Type: Microsoft.Online.SharePoint.TenantManagement.SharingLinkType Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -805,6 +847,8 @@ Accept wildcard characters: False ### -DenyAddAndCustomizePages +> Applicable: SharePoint Online + Determines whether the Add And Customize Pages right is denied on the site collection. For more information about permission levels, see User permissions and permission levels in SharePoint. @@ -814,7 +858,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -824,6 +868,8 @@ Accept wildcard characters: False ### -DisableAppViews +> Applicable: SharePoint Online + **Note**: This parameter has been retired and no longer functions. Disables the Power Apps button. @@ -837,7 +883,7 @@ Possible values: Type: Microsoft.Online.SharePoint.TenantAdministration.AppViewsPolicy Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -847,6 +893,8 @@ Accept wildcard characters: False ### -DisableCompanyWideSharingLinks +> Applicable: SharePoint Online + Disables People in your organization links. For more information, see [People in your organization sharing links](/microsoft-365/solutions/microsoft-365-limit-sharing#people-in-your-organization-sharing-links). Possible values @@ -859,7 +907,7 @@ Possible values Type: Microsoft.Online.SharePoint.TenantAdministration.CompanyWideSharingLinksPolicy Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -869,6 +917,8 @@ Accept wildcard characters: False ### -DisableFlows +> Applicable: SharePoint Online + **Note**: This parameter has been retired and no longer functions. Disables the Power Automate button. @@ -881,7 +931,7 @@ Possible values Type: Microsoft.Online.SharePoint.TenantAdministration.FlowsPolicy Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -891,13 +941,15 @@ Accept wildcard characters: False ### -DisableSharingForNonOwners +> Applicable: SharePoint Online + This parameter prevents non-owners from inviting new users to the site. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet3 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -907,6 +959,8 @@ Accept wildcard characters: False ### -EnableAutoExpirationVersionTrim +> Applicable: SharePoint Online + SharePoint Administrators can set site-level version history limit settings that universally apply to new versions created on all new document libraries created on the site. Also can create request to set the version setting for existing libraries that enabled versioning. When version history limits are managed automatically, SharePoint employs an algorithm behind the scenes that deletes (thins out) intermittent older versions that are least likely to be needed, while preserving sufficient high-value versions - more versions in the recent past and fewer farther back in time - in case restores are required. @@ -929,7 +983,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: SetSiteFileVersionPolicy Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -939,6 +993,8 @@ Accept wildcard characters: False ### -EnablePWA +> Applicable: SharePoint Online + Determines whether site can include Project Web App. For more information about Project Web App, see Plan SharePoint groups in Project Server. @@ -946,7 +1002,7 @@ For more information about Project Web App, see Plan SharePoint groups in Projec Type: System.Boolean Parameter Sets: ParamSet2 Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -956,6 +1012,8 @@ Accept wildcard characters: False ### -ExcludeBlockDownloadPolicySiteOwners +> Applicable: SharePoint Online + Controls if site owners are excluded from block download policy. PARAMVALUE: False | True @@ -964,7 +1022,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -974,13 +1032,15 @@ Accept wildcard characters: False ### -ExcludeBlockDownloadSharePointGroups +> Applicable: SharePoint Online + Specifies the groups excluded from the block download policy. ```yaml Type: System.String[] Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -990,13 +1050,15 @@ Accept wildcard characters: False ### -ExcludedBlockDownloadGroupIds +> Applicable: SharePoint Online + Exempts users from specified groups from the block download policy and they can fully download any content for the site. ```yaml Type: System.Guid[] Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1006,6 +1068,8 @@ Accept wildcard characters: False ### -ExpireVersionsAfterDays +> Applicable: SharePoint Online + When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), admins will need to set the limits to the number of major versions (`MajorVersionLimit`), the number of major with minor versions (`MajorWithMinorVersionsLimit`) and the time period the versions are stored (`ExpireVersionsAfterDays`). Please check the description of `EnableAutoExpirationVersionTrim` for more details. PARAMVALUE: Int32 @@ -1014,7 +1078,7 @@ PARAMVALUE: Int32 Type: System.Int32 Parameter Sets: SetSiteFileVersionPolicy Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1024,6 +1088,8 @@ Accept wildcard characters: False ### -ExternalUserExpirationInDays +> Applicable: SharePoint Online + Specifies all external user expiration which will expire after the set number of days. Only applies if OverrideTenantExternalUserExpirationPolicy is set to true. The maximum value is 730. To remove the expiration requirement, set the value to zero (0). @@ -1032,7 +1098,7 @@ The maximum value is 730. To remove the expiration requirement, set the value to Type: System.Int32 Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1042,6 +1108,8 @@ Accept wildcard characters: False ### -HidePeoplePreviewingFiles +> Applicable: SharePoint Online + This setting disables the feature in OneDrive and SharePoint file previewing that displays the presence of other users on the file. It does not affect any experiences outside of the previewer. PARAMVALUE: False | True @@ -1052,7 +1120,7 @@ If set to True, the presence of other users on the file will no longer be displa Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1062,6 +1130,8 @@ Accept wildcard characters: False ### -HidePeopleWhoHaveListsOpen +> Applicable: SharePoint Online + This setting disables the feature in Microsoft Lists that displays the presence of other users on the list and its items when they are viewing. PARAMVALUE: False | True @@ -1072,7 +1142,7 @@ If set to True, the presence of other users on the list and its items will no lo Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1082,13 +1152,15 @@ Accept wildcard characters: False ### -HubSiteId +> Applicable: SharePoint Online + Sets the hub site for a specified SharePoint site. ```yaml Type: System.Guid Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1098,13 +1170,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + Specifies the URL of the site collection to update. ```yaml Type: SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -1114,13 +1188,15 @@ Accept wildcard characters: False ### -InformationBarriersMode +> Applicable: SharePoint Online + Specifies the information barrier mode. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1130,13 +1206,15 @@ Accept wildcard characters: False ### -InheritVersionPolicyFromTenant +> Applicable: SharePoint Online + Clear the file version setting at site level. The new document libraries will use the Tenant Level setting. It won't impact the existing document libraries. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: InheritVersionPolicyFromTenant Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1146,6 +1224,8 @@ Accept wildcard characters: False ### -LimitedAccessFileType +> Applicable: SharePoint Online + The following parameters can be used with -ConditionalAccessPolicy AllowLimitedAccess for both the organization-wide setting and the site-level setting. - OfficeOnlineFilesOnly: Allows users to preview only Office files in the browser. This option increases security but may be a barrier to user productivity. @@ -1158,7 +1238,7 @@ The following parameters can be used with -ConditionalAccessPolicy AllowLimitedA Type: Microsoft.Online.SharePoint.TenantManagement.SPOLimitedAccessFileType Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1199,6 +1279,8 @@ Accept wildcard characters: False ### -LockState +> Applicable: SharePoint Online + Sets the lock state on a site. Valid values are: NoAccess, ReadOnly and Unlock. When the lock state of a site is ReadOnly, a message will appear on the site stating that the site is under maintenance and it is read-only. @@ -1211,7 +1293,7 @@ It isn't possible to set the lock state on the root site collection. Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1221,6 +1303,8 @@ Accept wildcard characters: False ### -LoopDefaultSharingLinkRole +> Applicable: SharePoint Online + Gets or sets default share link role for fluid on the site. The valid values are: @@ -1235,7 +1319,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1245,6 +1329,8 @@ Accept wildcard characters: False ### -LoopDefaultSharingLinkScope +> Applicable: SharePoint Online + Gets or sets default share link scope for fluid on the site. The valid values are: @@ -1258,7 +1344,7 @@ The valid values are: Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1268,6 +1354,8 @@ Accept wildcard characters: False ### -MajorVersionLimit +> Applicable: SharePoint Online + When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), admins will need to set the limits to the number of major versions (`MajorVersionLimit`) and the time period the versions are stored (`ExpireVersionsAfterDays`). Please check the description of `EnableAutoExpirationVersionTrim` for more details. PARAMVALUE: Int32 @@ -1276,7 +1364,7 @@ PARAMVALUE: Int32 Type: System.Int32 Parameter Sets: SetSiteFileVersionPolicy Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1286,6 +1374,8 @@ Accept wildcard characters: False ### -MajorWithMinorVersionsLimit +> Applicable: SharePoint Online + When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), admins will need to set the limits to the number of major versions (`MajorVersionLimit`), the number of major with minor versions (`MajorWithMinorVersionsLimit`) and the time period the versions are stored (`ExpireVersionsAfterDays`). Please check the description of `EnableAutoExpirationVersionTrim` for more details. PARAMVALUE: Int32 @@ -1294,7 +1384,7 @@ PARAMVALUE: Int32 Type: System.Int32 Parameter Sets: SetSiteFileVersionPolicy Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1304,6 +1394,8 @@ Accept wildcard characters: False ### -MediaTranscription +> Applicable: SharePoint Online + When the feature is enabled, videos can have transcripts generated on demand or generated automatically in certain scenarios. This is the default because the policy is default on. If a video owner decides they don't want the transcript, they can always hide or delete it from that video. Possible values: @@ -1314,7 +1406,7 @@ Possible values: Type: Microsoft.Online.SharePoint.TenantManagement.MediaTranscriptionPolicyType Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1324,13 +1416,15 @@ Accept wildcard characters: False ### -NoWait +> Applicable: SharePoint Online + Specifies to continue executing script immediately. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1340,6 +1434,8 @@ Accept wildcard characters: False ### -OverrideBlockUserInfoVisibility +> Applicable: SharePoint Online + Choose whether to override the Block User Info Visibility policy on this site. PARAMVALUE: @@ -1353,7 +1449,7 @@ PARAMVALUE: Type: Microsoft.Online.SharePoint.TenantAdministration.SiteUserInfoVisibilityPolicyValue Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1363,6 +1459,8 @@ Accept wildcard characters: False ### -OverrideSharingCapability +> Applicable: SharePoint Online + Determines whether it should override the sharing capability on its partition. For example, if the tenant sharing capability is `ExternalUserAndGuestSharing`, the core partition sharing capability is `Disabled`, and the sharing capability defined on the site collection is `ExternalUserAndGuestSharing`, the effective site sharing capability should be `Disabled` (the most restrictive one among tenant, partition, and site collecction) if `OverrideSharingCapability` is `false`. If `OverrideSharingCapability` is `true`, it skips checking partition sharing capability and the effective site sharing capability should be `ExternalUserAndGuestSharing`. PARAMVALUE: False | True @@ -1371,7 +1469,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1381,6 +1479,8 @@ Accept wildcard characters: False ### -OverrideTenantAnonymousLinkExpirationPolicy +> Applicable: SharePoint Online + Choose whether to override the anonymous or anyone link expiration policy on this site. PARAMVALUE: None | False | True @@ -1393,7 +1493,7 @@ PARAMVALUE: None | False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1403,6 +1503,8 @@ Accept wildcard characters: False ### -OverrideTenantExternalUserExpirationPolicy +> Applicable: SharePoint Online + Choose whether to override the external user expiration policy on this site. Possible values: @@ -1415,7 +1517,7 @@ Possible values: Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1425,13 +1527,15 @@ Accept wildcard characters: False ### -Owner +> Applicable: SharePoint Online + Specifies the owner of the site collection. Changing the Owner of a OneDrive is not supported and causes many experiences to break. ```yaml Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1441,6 +1545,8 @@ Accept wildcard characters: False ### -ReadOnlyForBlockDownloadPolicy +> Applicable: SharePoint Online + Controls if read-only should be enabled for block download policy. PARAMVALUE: False | True @@ -1449,7 +1555,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1510,13 +1616,15 @@ Accept wildcard characters: False ### -RemoveRestrictedAccessControlGroups +> Applicable: SharePoint Online + Specifies the IDs of groups to be removed from access restriction policy and lose access. ```yaml Type: System.Guid[] Parameter Sets: RemoveRestrictedAccessControlGroups Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1526,6 +1634,8 @@ Accept wildcard characters: False ### -RequestFilesLinkEnabled +> Applicable: SharePoint Online + Enables or disables the Request Files link on the site. PARAMVALUE: False | True @@ -1534,7 +1644,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1544,6 +1654,8 @@ Accept wildcard characters: False ### -RequestFilesLinkExpirationInDays +> Applicable: SharePoint Online + Specifies the number of days before a Request Files link expires for the site. The value can be from 0 to 730 days. @@ -1552,7 +1664,7 @@ The value can be from 0 to 730 days. Type: System.Int32 Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1579,13 +1691,15 @@ Accept wildcard characters: False ### -ResourceQuotaWarningLevel +> Applicable: SharePoint Online + Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the resource quota. ```yaml Type: System.Double Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1595,6 +1709,8 @@ Accept wildcard characters: False ### -RestrictContentOrgWideSearch +> Applicable: SharePoint Online + Controls whether org-wide content search is enabled for a site. PARAMVALUE: False | True @@ -1603,7 +1719,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1613,6 +1729,8 @@ Accept wildcard characters: False ### -RestrictedAccessControl +> Applicable: SharePoint Online + Sets access restriction policy by group membership. PARAMVALUE: False | True @@ -1621,7 +1739,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1631,13 +1749,15 @@ Accept wildcard characters: False ### -RestrictedAccessControlGroups +> Applicable: SharePoint Online + Specifies the IDs of groups that have access under an access restriction policy. ```yaml Type: System.Guid[] Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1663,13 +1783,15 @@ Accept wildcard characters: False ### -RestrictedToGeo +> Applicable: SharePoint Online + PARAMVALUE: NoRestriction | BlockMoveOnly | BlockFull | Unknown ```yaml Type: Microsoft.Online.SharePoint.TenantAdministration.RestrictedToRegion Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1679,13 +1801,15 @@ Accept wildcard characters: False ### -SandboxedCodeActivationCapability +> Applicable: SharePoint Online + PARAMVALUE: Unknown | Check | Disabled | Enabled ```yaml Type: Microsoft.Online.SharePoint.TenantAdministration.SandboxedCodeActivationCapabilities Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1695,13 +1819,15 @@ Accept wildcard characters: False ### -SensitivityLabel +> Applicable: SharePoint Online + Used to specify the unique identifier (GUID) of the SensitivityLabel. ```yaml Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1711,6 +1837,8 @@ Accept wildcard characters: False ### -SharingAllowedDomainList +> Applicable: SharePoint Online + Specifies a list of email domains that are allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](/sharepoint/restricted-domains-sharing). @@ -1719,7 +1847,7 @@ For additional information about how to restrict a domain sharing, see [Restrict Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1729,6 +1857,8 @@ Accept wildcard characters: False ### -SharingBlockedDomainList +> Applicable: SharePoint Online + Specifies a list of email domains that are blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](/sharepoint/restricted-domains-sharing). @@ -1737,7 +1867,7 @@ For additional information about how to restrict a domain sharing, see [Restrict Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1747,6 +1877,8 @@ Accept wildcard characters: False ### -SharingCapability +> Applicable: SharePoint Online + Determines what level of sharing is available for the site. The valid values are: @@ -1762,7 +1894,7 @@ For more information about sharing, see Turn external sharing on or off for Shar Type: Microsoft.Online.SharePoint.TenantManagement.SharingCapabilities Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1772,6 +1904,8 @@ Accept wildcard characters: False ### -SharingDomainRestrictionMode +> Applicable: SharePoint Online + Specifies the sharing mode for external domains. Possible values are: @@ -1786,7 +1920,7 @@ For additional information about how to restrict a domain sharing, see [Restrict Type: Microsoft.Online.SharePoint.TenantManagement.SharingDomainRestrictionModes Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1796,6 +1930,8 @@ Accept wildcard characters: False ### -ShowPeoplePickerSuggestionsForGuestUsers +> Applicable: SharePoint Online + To enable the option to search for existing guest users at site collection level, set this parameter to $true. PARAMVALUE: False | True @@ -1804,7 +1940,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1814,6 +1950,8 @@ Accept wildcard characters: False ### -SocialBarOnSitePagesDisabled +> Applicable: SharePoint Online + Disables or enables the Social Bar for Site Collection. The Social Bar will appear on all modern SharePoint pages with the exception of the home page of a site. It will give users the ability to like a page, see the number of views, likes, and comments on a page, and see the people who have liked a page. @@ -1824,7 +1962,7 @@ PARAMVALUE: False | True Type: System.Boolean Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1834,13 +1972,15 @@ Accept wildcard characters: False ### -StorageQuota +> Applicable: SharePoint Online + Specifies the storage quota in megabytes of the site collection. ```yaml Type: System.Int64 Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1850,13 +1990,15 @@ Accept wildcard characters: False ### -StorageQuotaReset +> Applicable: SharePoint Online + Resets the OneDrive for Business storage quota to the tenant's new default storage space. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1866,13 +2008,15 @@ Accept wildcard characters: False ### -StorageQuotaWarningLevel +> Applicable: SharePoint Online + Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the storage quota. ```yaml Type: System.Int64 Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1882,13 +2026,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + Specifies the title of the site collection. ```yaml Type: System.String Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1913,13 +2059,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1929,13 +2077,15 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + The WhatIf switch doesn't work on this cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md index a012f8318..293d68005 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md @@ -50,6 +50,8 @@ This example triggers the reactivation of a site. If the site is reactivated fro ### -ArchiveState +> Applicable: SharePoint Online + Sets the archived state of the site. Valid values are Archived, Active. ```yaml @@ -57,7 +59,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.SPOArchiveState Parameter Sets: (All) Aliases: Accepted values: Archived, Active -Applicable: SharePoint Online + Required: True Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteDesign.md index 3b51f7abb..281e52b92 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteDesign.md @@ -53,13 +53,15 @@ Updates a previously uploaded site design. ### -Description +> Applicable: SharePoint Online + The display description of the site design. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -84,13 +86,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + The site design Id. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -100,13 +104,15 @@ Accept wildcard characters: False ### -IsDefault +> Applicable: SharePoint Online + A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](/sharepoint/dev/declarative-customization/customize-default-site-design). ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -116,13 +122,15 @@ Accept wildcard characters: False ### -PreviewImageAltText +> Applicable: SharePoint Online + The alt text description of the image for accessibility. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -132,13 +140,15 @@ Accept wildcard characters: False ### -PreviewImageUrl +> Applicable: SharePoint Online + The URL of a preview image. If none is specified, SharePoint uses a generic image. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -148,13 +158,15 @@ Accept wildcard characters: False ### -SiteScripts +> Applicable: SharePoint Online + An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -164,13 +176,15 @@ Accept wildcard characters: False ### -ThumbnailUrl +> Applicable: SharePoint Online + The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -180,13 +194,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + The display name of the site design. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -211,13 +227,15 @@ Accept wildcard characters: False ### -WebTemplate +> Applicable: SharePoint Online + Identifies which base template to add the design to. Use the value **64** for the Team site template, and the value **68** for the Communication site template. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteGroup.md index 1ebad3d2c..bac29eb63 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteGroup.md @@ -52,13 +52,15 @@ Example 2 sets Melissa.kerr@contoso.com as the owner of the ProjectViewers group ### -Identity +> Applicable: SharePoint Online + Specifies the name of the group. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -68,13 +70,15 @@ Accept wildcard characters: False ### -Name +> Applicable: SharePoint Online + Specifies the new name of the group. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -84,13 +88,15 @@ Accept wildcard characters: False ### -Owner +> Applicable: SharePoint Online + Specifies the owner (individual or a security group) of the group to be created. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -100,6 +106,8 @@ Accept wildcard characters: False ### -PermissionLevelsToAdd +> Applicable: SharePoint Online + Specifies the permission levels to grant to the group. > [!NOTE] @@ -109,7 +117,7 @@ Specifies the permission levels to grant to the group. Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -119,6 +127,8 @@ Accept wildcard characters: False ### -PermissionLevelsToRemove +> Applicable: SharePoint Online + Specifies the permission levels to remove from the group. > [!NOTE] @@ -128,7 +138,7 @@ Specifies the permission levels to remove from the group. Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -138,13 +148,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the site collection the group belongs to. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md index b4df3f63c..dfc903ca9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md @@ -51,13 +51,15 @@ Set-SPOSiteOffice365Group -Site https://contoso.sharepoint.com/sites/classicsite ### -Alias +> Applicable: SharePoint Online + Specifies the email alias for the new Microsoft 365 Group that will be created. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 @@ -68,6 +70,8 @@ Accept wildcard characters: False ### -Classification +> Applicable: SharePoint Online + Specifies the classification value, if classifications are set for the organization. If no value is provided, the default classification will be set, if one is configured. See [Microsoft Entra cmdlets for configuring group settings](https://go.microsoft.com/fwlink/?LinkID=827484) and follow the steps in the Create settings at the directory level to define the classification for Office 365 groups. @@ -78,7 +82,7 @@ See [Manage Office 365 Groups with PowerShell](https://support.office.com/en-us/ Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 5 @@ -89,13 +93,15 @@ Accept wildcard characters: False ### -Description +> Applicable: SharePoint Online + Specifies the group's description. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 4 @@ -106,13 +112,15 @@ Accept wildcard characters: False ### -DisplayName +> Applicable: SharePoint Online + Specifies the name of the new Microsoft 365 Group that will be created. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -123,13 +131,15 @@ Accept wildcard characters: False ### -IsPublic +> Applicable: SharePoint Online + Determines the Microsoft 365 Group's privacy setting. If switch is included, the group will be public, otherwise it will be private. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 3 @@ -140,13 +150,15 @@ Accept wildcard characters: False ### -KeepOldHomepage +> Applicable: SharePoint Online + For sites that already have a modern page set as homepage, you can specify whether you want to keep it as the homepage. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 6 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScript.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScript.md index a71acd994..ed1c30329 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScript.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScript.md @@ -68,13 +68,15 @@ Set-SPOSiteScript -Identity edaec4ec-71e2-4026-ac1e-6686bb30190d -Content $newna ### -Content +> Applicable: SharePoint Online + The JSON value that describes the script. For more information, see the [JSON reference](/sharepoint/dev/declarative-customization/site-design-json-schema). ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -84,13 +86,15 @@ Accept wildcard characters: False ### -Description +> Applicable: SharePoint Online + A description of the script. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -100,13 +104,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + The id of the site design. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -116,13 +122,15 @@ Accept wildcard characters: False ### -Title +> Applicable: SharePoint Online + The display name of the site design. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -132,13 +140,15 @@ Accept wildcard characters: False ### -Version +> Applicable: SharePoint Online + A version number of the script. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStorageEntity.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStorageEntity.md index 8134deec6..10f05fdae 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStorageEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStorageEntity.md @@ -41,13 +41,15 @@ This example adds an entry to the property bag. ### -Comments +> Applicable: SharePoint Online + Comment for this property bag entry. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -57,13 +59,15 @@ Accept wildcard characters: False ### -Description +> Applicable: SharePoint Online + Description of the property. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -73,13 +77,15 @@ Accept wildcard characters: False ### -Key +> Applicable: SharePoint Online + The key in the property bag that should be added or updated. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -89,13 +95,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + URL to the tenant or site collection app catalog. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -105,13 +113,15 @@ Accept wildcard characters: False ### -Value +> Applicable: SharePoint Online + Value to be set. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -121,6 +131,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -128,7 +140,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -137,6 +149,8 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -144,7 +158,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md index 7b16ac501..6189a223a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md @@ -44,13 +44,15 @@ This example disables caching for all webs in the site collection https://contos ## PARAMETERS ### -IsEnabled + +> Applicable: SharePoint Online $true to enable caching, $false to disable caching. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -59,13 +61,15 @@ Accept wildcard characters: False ``` ### -SiteUrl + +> Applicable: SharePoint Online Specifies the absolute URL for the site collection's root web that needs its caching state to be set. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheWebState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheWebState.md index be2bf7f9d..54b1040b1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheWebState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheWebState.md @@ -43,13 +43,15 @@ This example disables caching for the web https://contoso.sharepoint.com/sites/p ## PARAMETERS ### -IsEnabled + +> Applicable: SharePoint Online $true to enable caching, $false to disable caching. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -58,13 +60,15 @@ Accept wildcard characters: False ``` ### -WebUrl + +> Applicable: SharePoint Online Specifies the absolute URL for the web that needs its caching state to be set. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md index 61aa829b4..b156173f6 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md @@ -655,13 +655,15 @@ This example disables the Power Apps Adaptive Card Extension. ### -AllOrganizationSecurityGroupId +> Applicable: SharePoint Online + Sets the All-Organization Security Group by object ID. This group is then used for other features, such as "EnableDiscoverableByOrganizationForVideos", if enabled. If you change the group ID associated with the All-Organization Security Group, it will only be effective on new shares or permission events. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -686,6 +688,8 @@ Accept wildcard characters: False ### -AllowClassicPublishingSiteCreation +> Applicable: SharePoint Online + This parameter allows creation of classic publishing site collections (templates BLANKINTERNETCONTAINER#0, CMSPUBLISHING#0 and BLANKINTERNET#0) and activation of classic publishing features in sites. The valid values are: @@ -697,7 +701,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -707,6 +711,8 @@ Accept wildcard characters: False ### -AllowCommentsTextOnEmailEnabled +> Applicable: SharePoint Online + When this parameter is true, the email notification that a user receives when is mentioned, includes the surrounding document context. Set it to false to disable this feature. PARAMVALUE: True | False @@ -715,7 +721,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -725,13 +731,15 @@ Accept wildcard characters: False ### -AllowDownloadingNonWebViewableFiles +> Applicable: SharePoint Online + This parameter has been deprecated. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -741,6 +749,8 @@ Accept wildcard characters: False ### -AllowEditing +> Applicable: SharePoint Online + Prevents users from editing Office files in the browser and copying and pasting Office file contents out of the browser window. PARAMVALUE: True | False @@ -749,7 +759,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: ParamSetMultipleSites Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -759,6 +769,8 @@ Accept wildcard characters: False ### -AllowEveryoneExceptExternalUsersClaimInPrivateSite +> Applicable: SharePoint Online + When this parameter is true, the "Everyone except external users" claim is available in the People Picker of a private site. Set it to false to disable this feature. The valid values are: @@ -770,7 +782,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -780,6 +792,8 @@ Accept wildcard characters: False ### -AllowGuestUserShareToUsersNotInSiteCollection +> Applicable: SharePoint Online + The AllowGuestUserShareToUsersNotInSiteCollection settings (defaulted to false) will allow guests to share to users not in the site. The valid values are: @@ -793,7 +807,7 @@ Note: When the value is set to True, you will also need to enable [SharePoint an Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -803,6 +817,8 @@ Accept wildcard characters: False ### -AllowOverrideForBlockUserInfoVisibility +> Applicable: SharePoint Online + Allow organization level policy for Block User Info Visibility to be overridden for a SharePoint site or OneDrive. Use Set-SPOSite to override the policy for a SharePoint site or OneDrive. The valid values are: @@ -815,7 +831,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -915,6 +931,8 @@ Accept wildcard characters: False ### -ApplyAppEnforcedRestrictionsToAdHocRecipients +> Applicable: SharePoint Online + When the feature is enabled, all guest users are subject to conditional access policy. By default guest users who are accessing SharePoint Online files with pass code are exempt from the conditional access policy. The valid values are: @@ -926,7 +944,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1026,6 +1044,8 @@ Accept wildcard characters: False ### -BccExternalSharingInvitations +> Applicable: SharePoint Online + When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. The valid values are: @@ -1037,7 +1057,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1047,6 +1067,8 @@ Accept wildcard characters: False ### -BccExternalSharingInvitationsList +> Applicable: SharePoint Online + Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. Multiple addresses can be specified by creating a comma separated list with no spaces. @@ -1059,7 +1081,7 @@ The valid values are: Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1114,6 +1136,8 @@ Accept wildcard characters: False ### -BlockDownloadLinksFileType +> Applicable: SharePoint Online + The valid values are: - WebPreviewableFiles @@ -1125,7 +1149,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.BlockDownloadLinksFileTypes Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1135,6 +1159,8 @@ Accept wildcard characters: False ### -BlockSendLabelMismatchEmail +> Applicable: SharePoint Online + When a sensitivity label mismatch occurs between the label on the document uploaded and the label on the site, SharePoint Online captures an audit record, and sends an Incompatible sensitivity label detected email notification to the person who uploaded the document and the site owner. The notification contains details of the document which caused the problem and the label assigned to the document and to the site. The comparison happens between the priority of these two labels. PARAMVALUE: True | False @@ -1143,7 +1169,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1153,13 +1179,15 @@ Accept wildcard characters: False ### -BlockUserInfoVisibility +> Applicable: SharePoint Online + This feature has not yet been rolled out to Production. Attempting to set this parameter before rollout is complete will result in an error message. More details on this feature will be available on release. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1169,6 +1197,8 @@ Accept wildcard characters: False ### -BlockUserInfoVisibilityInOneDrive +> Applicable: SharePoint Online + Blocks users from accessing User Info if they have Limited Access permission only to the OneDrive. The policy applies to all OneDrives in the organization. The valid values are: @@ -1185,7 +1215,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantAdministration.TenantBrowseUserInfoPolicyValue Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1195,6 +1225,8 @@ Accept wildcard characters: False ### -BlockUserInfoVisibilityInSharePoint +> Applicable: SharePoint Online + Blocks users from accessing User Info if they have Limited Access permission only to a SharePoint site. The policy applies to all SharePoint sites in the organization. The valid values are: @@ -1207,7 +1239,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantAdministration.TenantBrowseUserInfoPolicyValue Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1216,6 +1248,8 @@ Accept wildcard characters: False ``` ### -BusinessConnectivityServiceDisabled + +> Applicable: SharePoint Online Prevents access to features that depend on the Business Connectivity Service (BCS), including external lists, external columns, and external content types. PARAMVALUE: True | False @@ -1224,7 +1258,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1234,6 +1268,8 @@ Accept wildcard characters: False ### -CommentsOnFilesDisabled +> Applicable: SharePoint Online + Disables or enables commenting functionality on the files. PARAMVALUE: True | False @@ -1241,7 +1277,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1251,6 +1287,8 @@ Accept wildcard characters: False ### -CommentsOnListItemsDisabled +> Applicable: SharePoint Online + Disables or enables commenting functionality on list items. PARAMVALUE: True | False @@ -1258,7 +1296,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1268,6 +1306,8 @@ Accept wildcard characters: False ### -CommentsOnSitePagesDisabled +> Applicable: SharePoint Online + Disables or enables commenting functionality on the site pages. PARAMVALUE: True | False @@ -1275,7 +1315,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1285,6 +1325,8 @@ Accept wildcard characters: False ### -ConditionalAccessPolicy +> Applicable: SharePoint Online + Please read [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices ) documentation here to understand Conditional Access Policy usage in SharePoint Online. PARAMVALUE: AllowFullAccess | AllowLimitedAccess | BlockAccess @@ -1293,7 +1335,7 @@ PARAMVALUE: AllowFullAccess | AllowLimitedAccess | BlockAccess Type: Microsoft.Online.SharePoint.TenantManagement.SPOConditionalAccessPolicyType Parameter Sets: ParamSetMultipleSites Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1303,13 +1345,15 @@ Accept wildcard characters: False ### -ConditionalAccessPolicyErrorHelpLink +> Applicable: SharePoint Online + A Link for help when Conditional Access Policy blocks a user. This should be in a valid URL format. A valid URL format that begins with https:// or https://. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1415,6 +1459,8 @@ Accept wildcard characters: False ### -CoreLoopDefaultSharingLinkRole +> Applicable: SharePoint Online + This parameter sets the default share link role for Loop and Whiteboard files on SharePoint sites. The valid values are: @@ -1429,7 +1475,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1439,6 +1485,8 @@ Accept wildcard characters: False ### -CoreLoopDefaultSharingLinkScope +> Applicable: SharePoint Online + This parameter sets the default share link scope for Loop and Whiteboard files on SharePoint sites. The valid values are: @@ -1452,7 +1500,7 @@ The valid values are: Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1507,13 +1555,15 @@ Accept wildcard characters: False ### -CustomizedExternalSharingServiceUrl +> Applicable: SharePoint Online + Specifies a URL that will be appended to the error message that is surfaced when a user is blocked from sharing externally by policy. This URL can be used to direct users to internal portals to request help or to inform them about your organization's policies. An example value is " ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1538,6 +1588,8 @@ Accept wildcard characters: False ### -DefaultLinkPermission +> Applicable: SharePoint Online + Lets administrators choose the default permission of the link in the sharing dialog box in OneDrive for Business and SharePoint Online. This applies to anonymous access, internal and direct links. The valid values are View and Edit (default). @@ -1546,7 +1598,7 @@ The valid values are View and Edit (default). Type: Microsoft.Online.SharePoint.TenantManagement.SharingPermissionType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1571,6 +1623,8 @@ Accept wildcard characters: False ### -DefaultSharingLinkType +> Applicable: SharePoint Online + Lets administrators choose the default link type in the sharing dialog box in OneDrive for Business and SharePoint Online. For additional information about how to change the default link type, see Change the default link type when users get links for sharing. @@ -1589,7 +1643,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.SharingLinkType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1629,6 +1683,8 @@ Accept wildcard characters: False ### -DelegateRestrictedAccessControlManagement +> Applicable: SharePoint Online + Allows SharePoint administrators to delegate the management of Restricted access control policy on sites to site admins and owners. The valid values are: @@ -1639,7 +1695,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1649,6 +1705,8 @@ Accept wildcard characters: False ### -DelegateRestrictedContentDiscoverabilityManagement +> Applicable: SharePoint Online + Allows SharePoint administrators to delegate the management of Restricted content discoverability policy on sites to site admins and owners. The valid values are: @@ -1659,7 +1717,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1669,6 +1727,8 @@ Accept wildcard characters: False ### -DisableAddShortcutsToOneDrive +> Applicable: SharePoint Online + When the feature is disabled ($true), the option [Add shortcut to My files](https://support.microsoft.com/office/add-shortcuts-to-shared-folders-in-onedrive-for-work-or-school-d66b1347-99b7-4470-9360-ffc048d35a33) will be removed; any folders that have already been added will remain on the user's computer. PARAMVALUE: True | False @@ -1677,7 +1737,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1702,6 +1762,8 @@ Accept wildcard characters: False ### -DisableCustomAppAuthentication +> Applicable: SharePoint Online + Prevents apps using an Azure Access Control (ACS) app-only access token to access SharePoint. ACS, a service of Microsoft Entra ID, has been retired on November 7, 2018. This retirement does not impact the SharePoint add-in model, which uses the https://accounts.accesscontrol.windows.net hostname (which is not impacted by this retirement). For new tenants, apps using an ACS app-only access token are disabled by default. We recommend using the Microsoft Entra app-only model which is modern and more secure. Note that marking this property to $true doesn't prevent creating apps in SharePoint that use an Azure Access Control (ACS) app-only access token. Marking this property to $true only ensures that such apps can't access SharePoint anymore. Accepts a value of true or false. By default this feature is set to true. @@ -1710,7 +1772,7 @@ Accepts a value of true or false. By default this feature is set to true. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1720,6 +1782,8 @@ Accept wildcard characters: False ### -DisabledAdaptiveCardExtensionIds +> Applicable: SharePoint Online + Allows administrators to prevent certain Adaptive Card Extensions from being added to pages or rendering on pages on which they were previously added. Currently, only the following Adaptive Card Extensions can be disabled in such a manner: | Adaptive Card Extension Name | GUID | @@ -1734,7 +1798,7 @@ To re-enable some disabled Adaptive Card Extensions, use the `Set-SPOTenant` wit Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1744,6 +1808,8 @@ Accept wildcard characters: False ### -DisableDocumentLibraryDefaultLabeling +> Applicable: SharePoint Online + This switch allows tenant admins to disable the capability of configuring a default sensitivity label for a document library. PARAMVALUE: True | False @@ -1755,7 +1821,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1765,6 +1831,8 @@ Accept wildcard characters: False ### -DisabledWebPartIds +> Applicable: SharePoint Online + Allows administrators to prevent certain web parts from being added to pages or rendering on pages on which they were previously added. Currently, only the following web parts can be disabled in such a manner: - Amazon Kindle: 46698648-fcd5-41fc-9526-c7f7b2ace919 @@ -1782,7 +1850,7 @@ To re-enable some disabled web parts, use the Set-SPOTenant with the -DisabledWe Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1807,6 +1875,8 @@ Accept wildcard characters: False ### -DisableOutlookPSTVersionTrimming +> Applicable: SharePoint Online + This parameter has no effect and it was used to opt-out of PST files retention policy changes as communicated in MC256835 (May 2021). Starting August 16, 2021, the service started retaining 30 days worth of versions for any PST files stored in OneDrive for Business and SharePoint Online team site document libraries. This change was introduced to prevent cases of previous versions of PST files quickly consuming available storage. The change only impacts previous versions of PST files stored in your document library storage. As a best practice, PST files should not be uploaded on OneDrive for Business and SharePoint Online team site document libraries due to the impact on storage and network bandwidth. @@ -1816,7 +1886,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1841,6 +1911,8 @@ Accept wildcard characters: False ### -DisableSharePointStoreAccess +> Applicable: SharePoint Online + This feature allows the SharePoint Administrators to disable SharePoint Store access for all users in the tenant. Accepts a value of true (enabled) to hide the SharePoint app store or false (disabled) to show the SharePoint app store. By default this feature is set to false. @@ -1849,7 +1921,7 @@ Accepts a value of true (enabled) to hide the SharePoint app store or false (dis Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1904,6 +1976,8 @@ Accept wildcard characters: False ### -DisallowInfectedFileDownload +> Applicable: SharePoint Online + Prevents the Download button from being displayed on the Virus Found warning page. Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. @@ -1912,7 +1986,7 @@ Accepts a value of true (enabled) to hide the Download button or false (disabled Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1922,6 +1996,8 @@ Accept wildcard characters: False ### -DisplayStartASiteOption +> Applicable: SharePoint Online + Determines whether tenant users see the Start a Site menu option. The valid values are: @@ -1933,7 +2009,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2033,13 +2109,15 @@ Accept wildcard characters: False ### -EmailAttestationReAuthDays +> Applicable: SharePoint Online + Sets the number of days for email attestation re-authentication. Value can be from 1 to 365 days. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2049,6 +2127,8 @@ Accept wildcard characters: False ### -EmailAttestationRequired +> Applicable: SharePoint Online + Sets email attestation to required. If people who use a verification code select to "stay signed in" in the browser, they must prove that they can access the same account that they used to redeem the sharing invitation. You can set the number of days for email attestation with **-EmailAttestationReAuthDays**. This setting affects only ad-hoc external recipients. @@ -2059,7 +2139,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2069,6 +2149,8 @@ Accept wildcard characters: False ### -EnableAIPIntegration +> Applicable: SharePoint Online + This parameter enables SharePoint to process the content of files stored in SharePoint and OneDrive with sensitivity labels that include encryption. For more information, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files). PARAMVALUE: True | False @@ -2077,7 +2159,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2102,6 +2184,8 @@ Accept wildcard characters: False ### -EnableAutoNewsDigest +> Applicable: SharePoint Online + Enable or disable auto news digest. [Documentation](https://aka.ms/autonewsdigest) for auto news digest. PARAMVALUE: True | False @@ -2110,7 +2194,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2120,6 +2204,8 @@ Accept wildcard characters: False ### -EnableAzureADB2BIntegration +> Applicable: SharePoint Online + Enables OneDrive and SharePoint integration with Microsoft Entra B2B. For more information, see [SharePoint and OneDrive integration with Microsoft Entra B2B](/sharepoint/sharepoint-azureb2b-integration). PARAMVALUE: True | False @@ -2128,7 +2214,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2153,6 +2239,8 @@ Accept wildcard characters: False ### -EnableGuestSignInAcceleration +> Applicable: SharePoint Online + Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. > [!NOTE] @@ -2162,7 +2250,7 @@ Accelerates guest-enabled site collections as well as member-only site collectio Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2187,6 +2275,8 @@ Accept wildcard characters: False ### -EnableMinimumVersionRequirement +> Applicable: SharePoint Online + This parameter was used to opt-out of the versioning setting update. It has no effect as of today as versioning setting has already been rolled out. PARAMVALUE: True | False @@ -2195,7 +2285,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2220,6 +2310,8 @@ Accept wildcard characters: False ### -EnablePromotedFileHandlers +> Applicable: SharePoint Online + This parameter is reserved for Microsoft internal use. PARAMVALUE: True | False @@ -2228,7 +2320,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2253,6 +2345,8 @@ Accept wildcard characters: False ### -EnableSensitivityLabelforPDF +> Applicable: SharePoint Online + Allows tenant admins to turn on support for PDFs with sensitivity labels for the following scenarios: - Applying a sensitivity label in Office for the web. @@ -2269,7 +2363,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2369,6 +2463,8 @@ Accept wildcard characters: False ### -ExternalServicesEnabled +> Applicable: SharePoint Online + Enables external services for a tenant. External services are defined as services that are not in the Office 365 datacenters. @@ -2381,7 +2477,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2391,6 +2487,8 @@ Accept wildcard characters: False ### -ExternalUserExpirationRequired +> Applicable: SharePoint Online + Specifies whether to enable the external user expiration policy, where external users will be expired and removed from the site collection in a given number of days. Note: Once the policy is enabled, expiration values will be set on external users as they join a site collection (via sharing links or via direct access). When the policy is disabled, it will no longer set expiration values on users, but it will not automatically clear expiration values set on existing users. The users can then have their expiration value cleared by a site collection administrator if required. @@ -2403,7 +2501,7 @@ False (default) - Disables the policy. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2413,13 +2511,15 @@ Accept wildcard characters: False ### -ExternalUserExpireInDays +> Applicable: SharePoint Online + Specifies the number of days before an external user will expire and be removed from the site collection if the policy is enabled. Value can be from 30 to 730 days. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2429,6 +2529,8 @@ Accept wildcard characters: False ### -FileAnonymousLinkType +> Applicable: SharePoint Online + Anonymous access links can allow recipients to only view or view and edit. The value can be set separately for folders and files. The valid values are: @@ -2440,7 +2542,7 @@ The valid values are: Type: Microsoft.SharePoint.Client.AnonymousLinkType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2450,13 +2552,15 @@ Accept wildcard characters: False ### -FilePickerExternalImageSearchEnabled +> Applicable: SharePoint Online + For Webparts that support inserting images, like for example Image or Hero webpart, the Web search (Powered by Bing) option will be available if enabled (the default). ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2466,6 +2570,8 @@ Accept wildcard characters: False ### -FolderAnonymousLinkType +> Applicable: SharePoint Online + Users can configure folder anonymous access links that allow recipients to view, view and upload, or view, edit, and upload files. The valid values are: @@ -2478,7 +2584,7 @@ The valid values are: Type: Microsoft.SharePoint.Client.AnonymousLinkType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2518,6 +2624,8 @@ Accept wildcard characters: False ### -IncludeAtAGlanceInShareEmails +> Applicable: SharePoint Online + Enable or disable the At A Glance feature in sharing e-mails. This provides the key points and time to read for the shared item if available. PARAMVALUE: True | False @@ -2526,7 +2634,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2551,6 +2659,8 @@ Accept wildcard characters: False ### -IPAddressAllowList +> Applicable: SharePoint Online + Configures multiple IP addresses or IP address ranges (IPv4 or IPv6), that are recognized as trusted. Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. @@ -2562,7 +2672,7 @@ Use commas to separate multiple IP addresses or IP address ranges. Verify there Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2572,6 +2682,8 @@ Accept wildcard characters: False ### -IPAddressEnforcement +> Applicable: SharePoint Online + Allows access from network locations that are defined by an administrator. The values are $true and $false. The default value is $false which means the setting is disabled. @@ -2582,7 +2694,7 @@ Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2592,6 +2704,8 @@ Accept wildcard characters: False ### -IPAddressWACTokenLifetime +> Applicable: SharePoint Online + Allows to set the session timeout. If you are a tenant administrator and you begin IP address enforcement for OneDrive for Business in Office 365, this enforcement automatically activates a tenant parameter IPAddressWACTokenLifetime. The default value is 15 minutes, when IP Address Enforcement is True. PARAMVALUE: Int32 @@ -2600,7 +2714,7 @@ PARAMVALUE: Int32 Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2685,6 +2799,8 @@ Accept wildcard characters: False ### -IsSharePointAddInsBlocked +> Applicable: SharePoint Online + When this feature is enabled, all functionalities of the add-ins will be restricted, preventing them from running or installing. The valid values are: @@ -2696,7 +2812,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2706,6 +2822,8 @@ Accept wildcard characters: False ### -IsSharePointAddInsDisabled +> Applicable: SharePoint Online + When the feature is enabled, all the add-ins features will be disabled. The valid values are: @@ -2717,7 +2835,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2727,6 +2845,8 @@ Accept wildcard characters: False ### -IsWBFluidEnabled +> Applicable: SharePoint Online + Sets whether Whiteboard is enabled or disabled for OneDrive for Business users. Whiteboard on OneDrive for Business is automatically enabled for applicable Microsoft 365 tenants but can be disabled. The valid values are: @@ -2738,7 +2858,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2748,6 +2868,8 @@ Accept wildcard characters: False ### -LabelMismatchEmailHelpLink +> Applicable: SharePoint Online + This parameter allows tenant admins to customize the "Help Link" in email with the subject "Incompatible sensitivity label detected." When a sensitivity label mismatch occurs between the label on the document uploaded and the label on the site, SharePoint Online captures an audit record and sends an Incompatible sensitivity label detected email notification to the person who uploaded the document and the site owner. The notification contains details of the document which caused the problem and the label assigned to the document and to the site. The comparison happens between the priority of these two labels. The value can be any valid URL. @@ -2756,7 +2878,7 @@ The value can be any valid URL. Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2766,6 +2888,8 @@ Accept wildcard characters: False ### -LegacyAuthProtocolsEnabled +> Applicable: SharePoint Online + By default this value is set to $True, which means that authentication using legacy protocols is enabled. Setting this parameter to $False prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. @@ -2780,7 +2904,7 @@ Setting this parameter to $False prevents Office clients using non-modern authen Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2805,6 +2929,8 @@ Accept wildcard characters: False ### -LimitedAccessFileType +> Applicable: SharePoint Online + Allows users to preview only Office files in the browser. This option increases security, but may be a barrier to user productivity. The following parameters can be used with `-ConditionalAccessPolicy AllowLimitedAccess` for both the organization-wide setting and the site-level setting. @@ -2819,7 +2945,7 @@ PARAMVALUE: OfficeOnlineFilesOnly | WebPreviewableFiles | OtherFiles Type: Microsoft.Online.SharePoint.TenantManagement.SPOLimitedAccessFileType Parameter Sets: ParamSetMultipleSites Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2844,6 +2970,8 @@ Accept wildcard characters: False ### -MarkNewFilesSensitiveByDefault +> Applicable: SharePoint Online + If external sharing is turned on, sensitive content could be shared and accessed by guests before the Office DLP rule finishes processing, you can address this issue by configuring this parameter. Possible values are @@ -2857,7 +2985,7 @@ For more information see [Mark new files as sensitive by default](/sharepoint/se Type: Microsoft.Online.SharePoint.TenantManagement.SensitiveByDefaultState Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2882,13 +3010,15 @@ Accept wildcard characters: False ### -MaxCompatibilityLevel +> Applicable: SharePoint Online + The only valid value is "15". ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2898,6 +3028,8 @@ Accept wildcard characters: False ### -MediaTranscription +> Applicable: SharePoint Online + When the feature is enabled, videos can have transcripts generated on demand or generated automatically in certain scenarios. This is the default because the policy is default on. If a video owner decides they don't want the transcript, they can always hide or delete it from that video. Possible values: @@ -2908,7 +3040,7 @@ Possible values: Type: Microsoft.Online.SharePoint.TenantManagement.MediaTranscriptionPolicyType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2918,6 +3050,8 @@ Accept wildcard characters: False ### -MediaTranscriptionAutomaticFeatures +> Applicable: SharePoint Online + When the feature is enabled, videos can have transcripts generated automatically on upload. The policy is default on. If a tenant admin decides to disable the feature, he can do so by disabling the policy at tenant level. This feature can not be enabled or disabled at site level. Possible values: @@ -2928,7 +3062,7 @@ Possible values: Type: Microsoft.Online.SharePoint.TenantManagement.MediaTranscriptionAutomaticFeaturesPolicyType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2938,13 +3072,15 @@ Accept wildcard characters: False ### -MinCompatibilityLevel +> Applicable: SharePoint Online + The only valid value is "15". ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2954,6 +3090,8 @@ Accept wildcard characters: False ### -NoAccessRedirectUrl +> Applicable: SharePoint Online + Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess." The valid values are: @@ -2965,7 +3103,7 @@ The valid values are: Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2975,6 +3113,8 @@ Accept wildcard characters: False ### -NotificationsInOneDriveForBusinessEnabled +> Applicable: SharePoint Online + Enables or disables notifications in OneDrive for Business. PARAMVALUE: True | False @@ -2983,7 +3123,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2993,6 +3133,8 @@ Accept wildcard characters: False ### -NotificationsInSharePointEnabled +> Applicable: SharePoint Online + Enables or disables notifications in SharePoint. PARAMVALUE: True | False @@ -3001,7 +3143,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3015,6 +3157,8 @@ This parameter has been deprecated since SharePoint Online legacy invitation flo ### -NotifyOwnersWhenItemsReshared +> Applicable: SharePoint Online + When this parameter is set to $true and another user re-shares a document from a user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail. For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. @@ -3025,7 +3169,7 @@ The valid values are $true and $false. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3035,6 +3179,8 @@ Accept wildcard characters: False ### -ODBAccessRequests +> Applicable: SharePoint Online + Lets administrators set policy on access requests and requests to share in OneDrive for Business. The valid values are: @@ -3047,7 +3193,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3057,6 +3203,8 @@ Accept wildcard characters: False ### -ODBMembersCanShare +> Applicable: SharePoint Online + Lets administrators set policy on re-sharing behavior in OneDrive for Business. The valid values are: @@ -3069,7 +3217,7 @@ The valid values are: Type: Microsoft.SharePoint.Client.SharingState Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3094,6 +3242,8 @@ Accept wildcard characters: False ### -OfficeClientADALDisabled +> Applicable: SharePoint Online + When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. The valid values are: @@ -3105,7 +3255,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3175,6 +3325,8 @@ Accept wildcard characters: False ### -OneDriveForGuestsEnabled +> Applicable: SharePoint Online + Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. The valid values are: @@ -3186,7 +3338,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3196,6 +3348,8 @@ Accept wildcard characters: False ### -OneDriveLoopDefaultSharingLinkRole +> Applicable: SharePoint Online + This parameter sets the default share link role for Loop and Whiteboard files on OneDrive sites. The valid values are: @@ -3210,7 +3364,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3220,6 +3374,8 @@ Accept wildcard characters: False ### -OneDriveLoopDefaultSharingLinkScope +> Applicable: SharePoint Online + Gets or sets default share link scope for Loop and Whiteboard files on OneDrive sites. The valid values are: @@ -3233,7 +3389,7 @@ The valid values are: Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3288,6 +3444,8 @@ Accept wildcard characters: False ### -OneDriveStorageQuota +> Applicable: SharePoint Online + Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default. @@ -3300,7 +3458,7 @@ If the value is set larger than the Maximum allowed OneDrive for Business quota, Type: System.Int64 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3310,6 +3468,8 @@ Accept wildcard characters: False ### -OrphanedPersonalSitesRetentionPeriod +> Applicable: SharePoint Online + Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. The value range is in days, between 30 and 3650. The default value is 30. @@ -3318,7 +3478,7 @@ The value range is in days, between 30 and 3650. The default value is 30. Type: Microsoft.Online.SharePoint.TenantAdministration.SyntexFeatureScopeValue Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3328,6 +3488,8 @@ Accept wildcard characters: False ### -OwnerAnonymousNotification +> Applicable: SharePoint Online + Enables or disables owner anonymous notification. If enabled, an email notification will be sent to the OneDrive for Business owners when anonymous links are created or changed. PARAMVALUE: True | False @@ -3336,7 +3498,7 @@ PARAMVALUE: True | False Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3346,6 +3508,8 @@ Accept wildcard characters: False ### -PermissiveBrowserFileHandlingOverride +> Applicable: SharePoint Online + Enables the Permissive browser file handling. By default, the browser file handling is set to Strict. The Strict setting adds headers that force the browser to download certain types of files. The forced download improves security by disallowing the automatic execution of Web content. When the setting is set to Permissive, no headers are added and certain types of files can be executed in the browser instead of download. The valid values are: @@ -3357,7 +3521,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantAdministration.SelectedSitesListOperations Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3367,6 +3531,8 @@ Accept wildcard characters: False ### -PreventExternalUsersFromResharing +> Applicable: SharePoint Online + Prevents external users from resharing files, folders, and sites that they do not own. PARAMVALUE: True | False @@ -3375,7 +3541,7 @@ PARAMVALUE: True | False Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3385,6 +3551,8 @@ Accept wildcard characters: False ### -ProvisionSharedWithEveryoneFolder +> Applicable: SharePoint Online + Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. The valid values are: @@ -3398,7 +3566,7 @@ The default behavior of the Shared with Everyone folder changed in August 2015. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3408,6 +3576,8 @@ Accept wildcard characters: False ### -PublicCdnAllowedFileTypes +> Applicable: SharePoint Online + Sets public CDN allowed file types, if the public CDN is enabled. PARAMVALUE: String @@ -3416,7 +3586,7 @@ PARAMVALUE: String Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3426,6 +3596,8 @@ Accept wildcard characters: False ### -PublicCdnEnabled +> Applicable: SharePoint Online + Enables or disables the public CDN. PARAMVALUE: True | False @@ -3434,7 +3606,7 @@ PARAMVALUE: True | False Type: Microsoft.Online.SharePoint.TenantAdministration.SyntexFeatureScopeValue Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3448,6 +3620,8 @@ This parameter has been deprecated since SharePoint Online legacy invitation flo ### -RequireAnonymousLinksExpireInDays +> Applicable: SharePoint Online + Specifies the upper bound for user-created anonymous link expiration periods. All links created after setting this policy will expire by the end of a period spanning the set number of days. The value can be from 0 to 730 days. @@ -3458,7 +3632,7 @@ To remove the expiration requirement, set the value to zero (0). Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3468,6 +3642,8 @@ Accept wildcard characters: False ### -RequireOrganizationLinksExpireInDays +> Applicable: SharePoint Online + Specifies the upper bound for user-created organization link expiration periods. All links created after setting this policy will expire by the end of a period spanning the set number of days. The value can be from 0 to 730 days. @@ -3478,7 +3654,7 @@ To remove the expiration requirement, set the value to zero (0). Type: Microsoft.Online.SharePoint.TenantAdministration.SelectedSitesListOperations Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3488,6 +3664,8 @@ Accept wildcard characters: False ### -ReSyncTenantPrivacyProfile +> Applicable: SharePoint Online + The 'SyncPrivacyProfileProperties' parameter is obsolete and renamed ReSyncTenantPrivacyProfile. This parameter enables the synchronization of privacy profile properties. @@ -3500,7 +3678,7 @@ Running 'Set-SPOTenant - ReSyncTenantPrivacyProfile' will force a sync from the Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3510,6 +3688,8 @@ Accept wildcard characters: False ### -SearchResolveExactEmailOrUPN +> Applicable: SharePoint Online + Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. This also does not allow SharePoint users to search for security groups or SharePoint groups. SharePoint Administrators will still be able to use starts with or partial name matching when enabled. @@ -3523,7 +3703,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3533,6 +3713,8 @@ Accept wildcard characters: False ### -SharingAllowedDomainList +> Applicable: SharePoint Online + Specifies a list of email domains that are allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see [Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business](https://support.office.com/en-US/article/Restricted-Domains-Sharing-in-Office-365-SharePoint-Online-and-OneDrive-for-Business-5d7589cd-0997-4a00-a2ba-2320ec49c4e9). @@ -3541,7 +3723,7 @@ For additional information about how to restrict a domain sharing, see [Restrict Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3551,6 +3733,8 @@ Accept wildcard characters: False ### -SharingBlockedDomainList +> Applicable: SharePoint Online + Specifies a list of email domains that are blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". For additional information about how to restrict a domain sharing, see [Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business](https://support.office.com/en-US/article/Restricted-Domains-Sharing-in-Office-365-SharePoint-Online-and-OneDrive-for-Business-5d7589cd-0997-4a00-a2ba-2320ec49c4e9). @@ -3559,7 +3743,7 @@ For additional information about how to restrict a domain sharing, see [Restrict Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3796,6 +3980,8 @@ Accept wildcard characters: False ### -SharingCapability +> Applicable: SharePoint Online + Determines what level of sharing is available for OneDrive and SharePoint sites. The valid values are: @@ -3811,7 +3997,7 @@ For more information about sharing, see [Manage sharing settings](/sharepoint/tu Type: Microsoft.Online.SharePoint.TenantManagement.SharingCapabilities Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3821,6 +4007,8 @@ Accept wildcard characters: False ### -SharingDomainRestrictionMode +> Applicable: SharePoint Online + Specifies the external sharing mode for domains. The valid values are: @@ -3835,7 +4023,7 @@ For additional information about how to restrict a domain sharing, see [Restrict Type: Microsoft.Online.SharePoint.TenantManagement.SharingDomainRestrictionModes Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3845,6 +4033,8 @@ Accept wildcard characters: False ### -ShowAllUsersClaim +> Applicable: SharePoint Online + Enables the administrator to hide the All Users claim groups in People Picker. When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Microsoft Entra ID who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organization members in the tenant that used NTLM to authentication with SharePoint. @@ -3861,7 +4051,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3871,6 +4061,8 @@ Accept wildcard characters: False ### -ShowEveryoneClaim +> Applicable: SharePoint Online + Enables the administrator to hide the Everyone claim in the People Picker. When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Microsoft Entra ID, including any active external users who have previously accepted invitations. @@ -3885,7 +4077,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3895,6 +4087,8 @@ Accept wildcard characters: False ### -ShowEveryoneExceptExternalUsersClaim +> Applicable: SharePoint Online + Enables the administrator to hide the "Everyone except external users" claim in the People Picker. When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Microsoft Entra ID, but not to any users who have previously accepted invitations. @@ -3907,7 +4101,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3947,6 +4141,8 @@ Accept wildcard characters: False ### -ShowPeoplePickerSuggestionsForGuestUsers +> Applicable: SharePoint Online + Shows people picker suggestions for guest users. To enable the option to search for existing guest users at Tenant Level, set this parameter to $true. PARAMVALUE: True | False @@ -3955,7 +4151,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3965,6 +4161,8 @@ Accept wildcard characters: False ### -SignInAccelerationDomain +> Applicable: SharePoint Online + Specifies the home realm discovery value to be sent to Microsoft Entra ID during the user sign-in process. When the organization uses a third-party identity provider, this prevents the user from seeing the Microsoft Entra Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. @@ -3985,7 +4183,7 @@ The valid values are: Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3995,6 +4193,8 @@ Accept wildcard characters: False ### -SiteOwnerManageLegacyServicePrincipalEnabled +> Applicable: SharePoint Online + Allows or disallows the site collection admins to manage the Azure Access Control (ACS) service principal. When the value is set to false, the service principal can only be created or updated by the SharePoint tenant admin. If the value is set to true, both the SharePoint tenant admin and site collection admin will be able to create or update the service principal through SharePoint. @@ -4003,7 +4203,7 @@ When the value is set to false, the service principal can only be created or upd Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4028,6 +4228,8 @@ Accept wildcard characters: False ### -SocialBarOnSitePagesDisabled +> Applicable: SharePoint Online + Disables or enables the Social Bar. The Social Bar will appear on all modern SharePoint pages with the exception of the home page of a site. It will give users the ability to like a page, see the number of views, likes, and comments on a page, and see the people who have liked a page. @@ -4038,7 +4240,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4048,6 +4250,8 @@ Accept wildcard characters: False ### -SpecialCharactersStateInFileFolderNames +> Applicable: SharePoint Online + Permits the use of special characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. > [!NOTE] @@ -4063,7 +4267,7 @@ The valid values are: Type: Microsoft.Online.SharePoint.TenantManagement.SpecialCharactersState Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4073,6 +4277,8 @@ Accept wildcard characters: False ### -StartASiteFormUrl +> Applicable: SharePoint Online + Specifies URL of the form to load in the Start a Site dialog. The valid values are: @@ -4084,7 +4290,7 @@ The valid values are: Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4188,6 +4394,8 @@ Accept wildcard characters: False ### -UseFindPeopleInPeoplePicker +> Applicable: SharePoint Online + This feature enables tenant admins to enable ODB and SPO to respect Exchange supports Address Book Policy (ABP) policies in the people picker. PARAMVALUE: True | False @@ -4199,7 +4407,7 @@ PARAMVALUE: True | False Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4207,6 +4415,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -UsePersistentCookiesForExplorerView + +> Applicable: SharePoint Online > [!NOTE] > This setting is not used anymore with Internet Explorer (IE) retired and the parameter would be removed soon. Users need to select "Yes" when prompted for "Stay signed in?" at the time of sign-in for "View in File Explorer" to work with Microsoft Edge. @@ -4227,7 +4437,7 @@ The valid values are: Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnEnabled.md index 9c0d15518..9d85a877b 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnEnabled.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnEnabled.md @@ -41,6 +41,8 @@ The example enables a CDN. ### -CdnType +> Applicable: SharePoint Online + Specifies the CDN type. The valid values are: public or private. ```yaml @@ -48,7 +50,7 @@ Type: Microsoft.Online.SharePoint.PowerShell.SPOTenantCdnTypeClient Parameter Sets: (All) Aliases: Accepted values: Public, Private, Both -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -58,6 +60,8 @@ Accept wildcard characters: False ### -Enable +> Applicable: SharePoint Online + Specifies if the CDN is enabled. The valid values are: $True and $False. @@ -66,7 +70,7 @@ The valid values are: $True and $False. Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -76,13 +80,15 @@ Accept wildcard characters: False ### -NoDefaultOrigins +> Applicable: SharePoint Online + PARAMVALUE: SwitchParameter ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -92,13 +98,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -108,6 +116,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: SharePoint Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -115,7 +125,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnPolicy.md index ee9a0dc68..c1b0d8938 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnPolicy.md @@ -49,6 +49,8 @@ This example sets the ExcludeRestrictedSiteClassifications policy for the select ### -CdnType +> Applicable: SharePoint Online + The CdnType parameter specifies the CDN type. The valid values are Public or Private. ```yaml @@ -56,7 +58,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -66,6 +68,8 @@ Accept wildcard characters: False ### -PolicyType +> Applicable: SharePoint Online + The PolicyType specifies the type of policy to set. Valid values: @@ -79,7 +83,7 @@ Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnPolicyType Parameter Sets: (All) Aliases: Accepted values: IncludeFileExtensions, ExcludeRestrictedSiteClassifications, ExcludeIfNoScriptDisabled, ExcludeRestrictedSiteClassificationsFileExtensions -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -89,13 +93,15 @@ Accept wildcard characters: False ### -PolicyValue +> Applicable: SharePoint Online + A String representing the value of the policy type defined by the PolicyType parameter. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantContentTypeReplicationParameters.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantContentTypeReplicationParameters.md index 8f51b442e..fe9152e12 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantContentTypeReplicationParameters.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantContentTypeReplicationParameters.md @@ -55,13 +55,15 @@ Tenant admin can also reset to replicate all the content types. ### -ReplicateAllContentTypes +> Applicable: SharePoint Online + The ReplicateAllContentTypes parameter specifies whether all content types should be replicated. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ReplicateAllContentTypes Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -71,13 +73,15 @@ Accept wildcard characters: False ### -ReplicatedContentTypes +> Applicable: SharePoint Online + Specifies a comma separated list of content types that should be replicated. ```yaml Type: System.String[] Parameter Sets: ReplicateSelectedContentTypes Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md index 8d645367e..43d3e5626 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md @@ -138,6 +138,8 @@ This example clears the ExcludedFileExtension list and lets all file types synce ### -BlockMacSync +> Applicable: SharePoint Online + Block Mac sync clients-- the Beta version and the new sync client (OneDrive.exe). The values for this parameter are True and False. The default value is False. @@ -145,7 +147,7 @@ The values for this parameter are True and False. The default value is False. Type: System.Management.Automation.SwitchParameter Parameter Sets: Blocking Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -156,11 +158,13 @@ Accept wildcard characters: False ### -DisableReportProblemDialog +> Applicable: SharePoint Online + ```yaml Type: System.Boolean Parameter Sets: ReportProblemDialogFeature Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -171,13 +175,15 @@ Accept wildcard characters: False ### -DomainGuids +> Applicable: SharePoint Online + Sets the [domain GUID](/powershell/module/activedirectory/get-addomain) of the computer domain membership to add to the safe recipient list. Requires a minimum of one domain GUID. The maximum number of domain GUIDs allowed is 125. ```yaml Type: System.String Parameter Sets: Blocking Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -188,13 +194,15 @@ Accept wildcard characters: False ### -Enable +> Applicable: SharePoint Online + Enables the feature to block sync originating from domains that are not present in the safe recipients list. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: Blocking Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -205,6 +213,8 @@ Accept wildcard characters: False ### -ExcludedFileExtensions +> Applicable: SharePoint Online + Blocks certain file types from syncing with the new sync client (OneDrive.exe). > [!NOTE] @@ -214,7 +224,7 @@ Blocks certain file types from syncing with the new sync client (OneDrive.exe). Type: System.String Parameter Sets: FileExclusion Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantTaxonomyReplicationParameters.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantTaxonomyReplicationParameters.md index d885782fe..32e50a138 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantTaxonomyReplicationParameters.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantTaxonomyReplicationParameters.md @@ -57,13 +57,15 @@ Tenant admin can also reset to replicate all the groups. ### -ReplicateAllGroups +> Applicable: SharePoint Online + This parameter specifies whether all groups should be replicated. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ReplicateAllGroups Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -73,13 +75,15 @@ Accept wildcard characters: False ### -ReplicatedGroups +> Applicable: SharePoint Online + Specifies a comma-separated list of groups that should be replicated. ```yaml Type: System.String[] Parameter Sets: ReplicateSelectedGroups Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUnifiedGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUnifiedGroup.md index e83fdb28c..0222f43c1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUnifiedGroup.md @@ -40,13 +40,15 @@ Sets the PDL for the Office 365 Group named 'EUTeam' to EUR (Europe). ### -GroupAlias +> Applicable: SharePoint Online + The alias of the Office 365 Group. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -56,13 +58,15 @@ Accept wildcard characters: False ### -PreferredDataLocation +> Applicable: SharePoint Online + The Preferred Data Location for the Office 365 Group. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUser.md index ce4ea6ae7..9328b7a3e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUser.md @@ -56,13 +56,15 @@ This example makes guest user adelev_fabrikam.onmicrosoft.com a SharePoint Onlin ### -IsSiteCollectionAdmin +> Applicable: SharePoint Online + Specifies whether the user is a site collection administrator. ```yaml Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -72,13 +74,15 @@ Accept wildcard characters: False ### -LoginName +> Applicable: SharePoint Online + Specifies the user name. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None @@ -88,13 +92,15 @@ Accept wildcard characters: False ### -Site +> Applicable: SharePoint Online + Specifies the full URL of the site collection. It must be in a valid managed path in the company's site. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOWebTheme.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOWebTheme.md index db47ac8d7..ee16056bc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOWebTheme.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOWebTheme.md @@ -40,13 +40,15 @@ This example sets the "Custom Cyan" theme to the https://contoso.sharepoint.com/ ### -Theme +> Applicable: SharePoint Online + Name of the theme or SPOTheme object ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind Parameter Sets: (All) Aliases: Identity, Name -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -55,13 +57,15 @@ Accept wildcard characters: False ``` ### -Web + +> Applicable: SharePoint Online Url of the site ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -71,6 +75,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` @@ -78,7 +84,7 @@ For more information, type the following command: `get-help about_commonparamete Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md index c4e9f9bb8..3077ea5f9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md @@ -60,13 +60,15 @@ Example 2 generates the Copilot agent insight report for a specified duration of ### -Force +> Applicable: SharePoint Online + It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -77,13 +79,15 @@ Accept wildcard characters: False ### -ReportPeriodInDays +> Applicable: SharePoint Online + It specifies the duration of the Copilot agent insight report in days. The possible values of ReportPeriodInDays are: 1, 7, 14, 28. If this parameter is not provided, it generates the report for a default duration of 1 day. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md index 770f4c63c..d06982a82 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md @@ -57,13 +57,15 @@ Example 2 generates the enterprise application insights report for a specified d ### -Force +> Applicable: SharePoint Online + It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -74,13 +76,15 @@ Accept wildcard characters: False ### -ReportPeriodInDays +> Applicable: SharePoint Online + It is an optional parameter, and it specifies the duration of the enterprise application insights report in days. The possible values of ReportPeriodInDays are: 1, 7, 14, 28. If this parameter is not provided, it generates the report for a default duration of 1 day. ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md index b82e6025c..e2c380934 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md @@ -50,13 +50,15 @@ Example 2 generates the restricted access control report which contains insights ### -ActionsBlockedByPolicy +> Applicable: SharePoint Online + It is an optional parameter, and it specifies the type of report generation to be triggered. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ### -Force +> Applicable: SharePoint Online + It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -84,13 +88,15 @@ Accept wildcard characters: False ### -RACProtectedSites +> Applicable: SharePoint Online + It is an optional parameter, and it specifies the type of report generation to be triggered. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md index fdc477290..3f01bb9cf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md @@ -70,13 +70,15 @@ Starts a site geo move for and a ### -DestinationDataLocation +> Applicable: SharePoint Online + Defines the new destination of the content that you want to move. This is the 3 letter data location value. ```yaml Type: System.String Parameter Sets: UrlAndDestinationDataLocation Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -86,13 +88,15 @@ Accept wildcard characters: False ### -DestinationUrl +> Applicable: SharePoint Online + Destination URL is optional in cases where the administrator wants to perform a site rename as part of the move. ```yaml Type: System.String Parameter Sets: UrlAndDestinationUrl Aliases: -Applicable: SharePoint Online + Required: True Position: 1 Default value: None @@ -118,13 +122,15 @@ Accept wildcard characters: False ### -PreferredMoveBeginDate +> Applicable: SharePoint Online + Specifies what is the preferred Date and time to start the move job. This is a preference and will be honored based on system resource availability. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 2 Default value: None @@ -134,13 +140,15 @@ Accept wildcard characters: False ### -PreferredMoveEndDate +> Applicable: SharePoint Online + Specifies what is the preferred Date and time to stop the move job from starting. This is a preference and will be honored based on system resource availability. If a the move is already in progress, we will complete the move. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 3 Default value: None @@ -150,13 +158,15 @@ Accept wildcard characters: False ### -Reserved +> Applicable: SharePoint Online + Reserved for Microsoft Internal use. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 4 Default value: None @@ -166,13 +176,15 @@ Accept wildcard characters: False ### -SourceSiteUrl +> Applicable: SharePoint Online + Specifies the source URL of the site collection you want to move. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 Default value: None @@ -242,13 +254,15 @@ Accept wildcard characters: False ### -ValidationOnly +> Applicable: SharePoint Online + This parameter will perform a validation check on whether the site can be moved and will not execute the move. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 5 Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index d4eabf52b..b80aca5e1 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -50,13 +50,15 @@ Starts OCR process for all content that hasn't been processed before in the sele ### -Site +> Applicable: SharePoint Online + Specifies the site where OCR process should be enabled on. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md index 659e513b2..5736b8d5a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md @@ -69,13 +69,15 @@ Starts the **simulation** rename of the SPO site with name "samplesite" to "rena ### -Identity +> Applicable: SharePoint Online + Specifies the original URL of the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -86,13 +88,15 @@ Accept wildcard characters: False ### -NewSiteTitle +> Applicable: SharePoint Online + Specifies the new Title of the site. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 @@ -103,13 +107,15 @@ Accept wildcard characters: False ### -NewSiteUrl +> Applicable: SharePoint Online + Specifies the new desired URL. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -120,13 +126,15 @@ Accept wildcard characters: False ### -Reserved +> Applicable: SharePoint Online + Reserved for Microsoft internal use. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -167,13 +175,15 @@ Accept wildcard characters: False ### -SuppressMarketplaceAppCheck +> Applicable: SharePoint Online + Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -184,13 +194,15 @@ Accept wildcard characters: False ### -SuppressWorkflow2013Check +> Applicable: SharePoint Online + Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -201,13 +213,15 @@ Accept wildcard characters: False ### -ValidationOnly +> Applicable: SharePoint Online + Verifies that the site address can be changed. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -217,13 +231,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Online Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -233,6 +249,8 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -240,7 +258,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md index 194bc8fd8..a8ac5ea14 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md @@ -47,6 +47,8 @@ Starts the rename of the SharePoint domain name to Fabrikam which is scheduled f ### -DomainName +> Applicable: SharePoint Online + Specifies the domain name that the current SharePoint domain name will be renamed to. This is the part before "sharepoint.com" or "onmicrosoft.com". > [!NOTE] @@ -56,7 +58,7 @@ Specifies the domain name that the current SharePoint domain name will be rename Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -67,13 +69,15 @@ Accept wildcard characters: False ### -ScheduledDateTime +> Applicable: SharePoint Online + Specifies the date-time that the job will be started. This should be at least 24 hours in the future, but no more than 30 days. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -83,13 +87,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: SharePoint Online Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -99,6 +105,8 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -106,7 +114,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md index 4c5c5472c..1f0475d2f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md @@ -58,13 +58,15 @@ This example moves the user username@contoso.onmicrosoft.com from their current ### -DestinationDataLocation +> Applicable: SharePoint Online + Defines the destination location where you want to move the user. Note that you may only move a user to their preferred data location. Thus before moving a user, you must change their preferred data location. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 2 @@ -75,13 +77,15 @@ Accept wildcard characters: False ### -Notify +> Applicable: SharePoint Online + Provides an SPO notification that the user is being moved. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 5 @@ -92,13 +96,15 @@ Accept wildcard characters: False ### -PreferredMoveBeginDate +> Applicable: SharePoint Online + Specifies what is the preferred date and time to begin the move. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 3 @@ -109,13 +115,15 @@ Accept wildcard characters: False ### -PreferredMoveEndDate +> Applicable: SharePoint Online + Specifies what is the preferred date and time to stop stop the move. Recommened when administrators are scripting large scale moves that they wish to complete within a timeframe. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 4 @@ -141,13 +149,15 @@ Accept wildcard characters: False ### -UserPrincipalName +> Applicable: SharePoint Online + UserPrincipalName or UPN defined for the specific user on the SPO tenant ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -158,13 +168,15 @@ Accept wildcard characters: False ### -ValidationOnly +> Applicable: SharePoint Online + Use this parameter to validate if the user is able to be moved. This parameter is recommended for any user move. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: 7 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md index d59cb60ad..7a4ff8443 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md @@ -46,13 +46,15 @@ Cancels the rename of the SharePoint domain name with the reason "Rescheduling". ### -Comment +> Applicable: SharePoint Online + Specifies an additional comment why the job is being canceled. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ### -Reason +> Applicable: SharePoint Online + Specifies the reason why the job is being canceled. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md index 2afc46839..190b899d8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md @@ -48,13 +48,15 @@ Equivalent to the one above ### -UserPrincipalName +> Applicable: SharePoint Online + UserPrincipalName or UPN defined for the specific user on the SPO tenant ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md index 0aca96457..421931d72 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md @@ -63,13 +63,15 @@ This example creates a new migration job in the target site collection for the w ### -AzureQueueUri +> Applicable: SharePoint Online + An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import. ```yaml Type: System.String Parameter Sets: AzureLocationsInline Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -80,13 +82,15 @@ Accept wildcard characters: False ### -Credentials +> Applicable: SharePoint Online + Optional credentials of a site collection administrator to use to connect to the site collection. The credentials should supply the username in UPN format (e.g. user@company.onmicrosoft.com). If this property is not set, the current tenant admin credentials from the session's previous call to `Connect-SPOService` will be used to connect to the site collection. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -97,13 +101,15 @@ Accept wildcard characters: False ### -EncryptionParameters +> Applicable: SharePoint Online + An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. ```yaml Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -114,13 +120,15 @@ Accept wildcard characters: False ### -FileContainerUri +> Applicable: SharePoint Online + A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package content files. ```yaml Type: System.String Parameter Sets: AzureLocationsInline Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -131,13 +139,15 @@ Accept wildcard characters: False ### -MigrationPackageAzureLocations +> Applicable: SharePoint Online + A set of fully qualified URLs and SAS tokens representing the Azure Blob Storage containers that hold the package content and metadata files and an optional Azure Storage Reporting Queue. This object is returned during successful processing of the `Set-SPOMigrationPackageAzureSource` cmdlet. ```yaml Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: AzureLocationsPipebind Aliases: -Applicable: SharePoint Online + Required: True Position: 1 @@ -148,13 +158,15 @@ Accept wildcard characters: False ### -NoLogFile +> Applicable: SharePoint Online + Indicates to not create a log file. The default is to create a new CreateMigrationJob log file within the current directory. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -165,13 +177,15 @@ Accept wildcard characters: False ### -PackageContainerUri +> Applicable: SharePoint Online + A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package metadata files. ```yaml Type: System.String Parameter Sets: AzureLocationsInline Aliases: -Applicable: SharePoint Online + Required: True Position: 2 @@ -182,13 +196,15 @@ Accept wildcard characters: False ### -TargetWebUrl +> Applicable: SharePoint Online + The fully qualified target web URL where the package will be imported into. This must include the same TargetWebURL that was used during `ConvertTo-SPOMigrationTargetedPackage`. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md index e94837547..4301cab32 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md @@ -46,13 +46,15 @@ This example runs all the site collection health checks on the Applicable: SharePoint Online + Specifies the SharePoint Online site collection to test. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: Named @@ -63,13 +65,15 @@ Accept wildcard characters: False ### -RuleId +> Applicable: SharePoint Online + Specifies the health check rule to run. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named @@ -80,13 +84,15 @@ Accept wildcard characters: False ### -RunAlways +> Applicable: SharePoint Online + Forces a rule to run even if a health check was run. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md index a9876770e..a3ead0b9c 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unlock-SPOSensitivityLabelEncryptedFile.md @@ -44,13 +44,15 @@ This example will remove a regular label with admin defined encryption from the ### -FileUrl +> Applicable: SharePoint Online + Full URL for the file. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 0 @@ -61,13 +63,15 @@ Accept wildcard characters: False ### -JustificationText +> Applicable: SharePoint Online + Text that explains the reason to run this cmdlet on the given file. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1 diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md index 61de5869f..cd1872cd7 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md @@ -66,13 +66,15 @@ Accept wildcard characters: False ### -Identity +> Applicable: SharePoint Online + Guid based identifier or URL of the site to disable the hub site feature. If hub site has been already deleted, you will need to use a Guid based identifier to remove the site from the list of hub sites. ```yaml Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite -Applicable: SharePoint Online + Required: True Position: 0 @@ -83,13 +85,15 @@ Accept wildcard characters: False ### -Confirm +> Applicable: SharePoint Online + Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + Required: False Position: Named @@ -99,6 +103,8 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: SharePoint Online Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -106,7 +112,7 @@ The cmdlet is not run. Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md index bc7ae3876..9c3635569 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md @@ -40,13 +40,15 @@ Updates the jdoe@contoso.com's UserType on all SharePoint Online sites in the te ### -LoginName +> Applicable: SharePoint Online + The login name of the target user to update across SharePoint Online. ```yaml Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True Position: 1