From e88b90555faebc60cd4677dd48bb75c8dec60820 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 15 Jul 2025 13:27:42 -0500 Subject: [PATCH 1/3] Update content and fix schema errors --- .../Add-SPOContainerTypeBilling.md | 68 +- .../Add-SPOContainerUser.md | 92 + .../Add-SPOContentSecurityPolicy.md | 27 +- .../Add-SPOFontPackage.md | 91 + .../Add-SPOGeoAdministrator.md | 16 +- .../Add-SPOHubSiteAssociation.md | 34 +- .../Add-SPOHubToHubAssociation.md | 22 +- .../Add-SPOListDesign.md | 14 +- .../Add-SPOOrgAssetsLibrary.md | 90 +- ...SPOServicePrioritizationAppRegistration.md | 11 +- .../Add-SPOSiteCollectionAppCatalog.md | 20 +- .../Add-SPOSiteDesign.md | 103 +- .../Add-SPOSiteDesignTask.md | 22 +- .../Add-SPOSiteOneDriveClassicFeatures.md | 115 + .../Add-SPOSiteScript.md | 34 +- .../Add-SPOSiteScriptPackage.md | 6 +- .../Add-SPOTenantCdnOrigin.md | 37 +- .../Add-SPOTenantIdentityMap.md | 61 + .../Add-SPOTenantIdentityMappingGroup.md} | 77 +- .../Add-SPOTenantIdentityMappingUser.md | 139 + ...dd-SPOTenantRestrictedSearchAllowedList.md | 99 + .../Add-SPOTheme.md | 38 +- .../Add-SPOUser.md | 20 +- .../Apply-SPOFontPackage.md | 76 + ...POTenantServicePrincipalPermissionGrant.md | 66 +- ...TenantServicePrincipalPermissionRequest.md | 66 +- .../Clear-SPOTenantPreAuthSettings.md | 45 +- .../Connect-SPOService.md | 89 +- .../ConvertTo-SPOMigrationEncryptedPackage.md | 46 +- .../ConvertTo-SPOMigrationTargetedPackage.md | 63 +- .../Copy-SPOPersonalSitePage.md | 83 +- ...TenantServicePrincipalPermissionRequest.md | 62 +- .../Disable-SPOTenantServicePrincipal.md | 88 + .../Disconnect-SPOService.md | 10 +- .../Enable-SPOCommSite.md | 40 +- .../Enable-SPOTenantServicePrincipal.md | 12 +- .../Export-SPODataAccessGovernanceInsight.md | 24 +- .../Export-SPOQueryLogs.md | 18 +- .../Export-SPOSites.md} | 44 +- .../Export-SPOUserInfo.md | 34 +- .../Export-SPOUserProfile.md | 20 +- .../Get-FileSensitivityLabelInfo.md | 19 +- .../Get-SPOAppBillingPolicies.md | 123 +- .../Get-SPOAppErrors.md | 20 +- .../Get-SPOAppInfo.md | 18 +- .../Get-SPOApplication.md | 58 +- ...DataCollectionStatusForActivityInsights.md | 13 +- ...t-SPOBlockedPageCreationContentTypeList.md | 46 + .../Get-SPOBrowserIdleSignOut.md | 14 +- .../Get-SPOBuiltInDesignPackageVisibility.md | 20 +- .../Get-SPOBuiltInFontPackageSettings.md | 25 +- .../Get-SPOBuiltInSiteTemplateSettings.md | 44 +- .../Get-SPOContainer.md | 146 +- .../Get-SPOContainerType.md | 38 +- .../Get-SPOContainerTypeConfiguration.md | 31 +- .../Get-SPOContentEventEmailAddresses.md | 23 +- .../Get-SPOContentSecurityPolicy.md | 25 +- .../Get-SPOCopilotAgentInsightsReport.md | 45 +- .../Get-SPOCopilotPromoOptInStatus.md | 59 + .../Get-SPOCopilotPromoUsage.md | 61 + .../Get-SPOCrossGeoMoveReport.md | 91 +- .../Get-SPOCrossGeoMovedUsers.md | 22 +- .../Get-SPOCrossGeoUsers.md | 24 +- .../Get-SPOCrossTenantCompatibilityStatus.md | 24 +- ...Get-SPOCrossTenantGroupContentMoveState.md | 199 + .../Get-SPOCrossTenantHostUrl.md | 18 +- .../Get-SPOCrossTenantRelationship.md | 46 + ...Get-SPOCrossTenantRelationshipByPartner.md | 61 + ...t-SPOCrossTenantRelationshipByScenario.md} | 29 +- .../Get-SPOCrossTenantSiteContentMoveState.md | 199 + .../Get-SPOCrossTenantUserContentMoveState.md | 199 + .../Get-SPODataAccessGovernanceInsight.md | 15 +- .../Get-SPODataEncryptionPolicy.md | 8 +- .../Get-SPODeletedContainer.md | 16 +- .../Get-SPODeletedSite.md | 56 +- .../Get-SPODisableSpacesActivation.md | 46 + .../Get-SPOEnterpriseAppInsightsReport.md | 44 +- .../Get-SPOExternalUser.md | 50 +- .../Get-SPOFontPackage.md | 61 + .../Get-SPOGeoAdministrator.md | 20 +- .../Get-SPOGeoMoveCrossCompatibilityStatus.md | 7 +- .../Get-SPOGeoStorageQuota.md | 22 +- .../Get-SPOHideDefaultThemes.md | 19 +- .../Get-SPOHomeSite.md | 14 +- .../Get-SPOHubSite.md | 32 +- ...et-SPOInformationBarriersInsightsReport.md | 38 +- ...formationBarriersPolicyComplianceReport.md | 61 + .../Get-SPOIsCommSite.md} | 40 +- .../Get-SPOKnowledgeHubSite.md | 46 + .../Get-SPOLandingSites.md | 61 + .../Get-SPOListDesign.md | 2 +- ...POListFileVersionBatchDeleteJobProgress.md | 42 +- ...tFileVersionExpirationReportJobProgress.md | 49 +- .../Get-SPOListVersionPolicy.md | 41 +- .../Get-SPOMalwareFile.md | 147 +- .../Get-SPOMalwareFileContent.md | 207 +- .../Get-SPOMigrationJobProgress.md | 45 +- .../Get-SPOMigrationJobStatus.md | 33 +- ...t-SPOMultiGeoCompanyAllowedDataLocation.md | 14 +- .../Get-SPOMultiGeoExperience.md | 16 +- .../Get-SPOOrgAssetsLibrary.md | 17 +- .../Get-SPOOrgNewsSite.md | 4 +- .../Get-SPOPersonalSitePageCopyProgress.md | 232 +- .../Get-SPOPortalLaunchWaves.md | 77 + .../Get-SPOPublicCdnOrigins.md | 16 +- ...Get-SPORestrictedAccessForSitesInsights.md | 39 +- ...ORestrictedContentDiscoverabilityReport.md | 77 + .../Get-SPORestrictedSiteCreation.md | 31 +- ...POServicePrioritizationAppRegistrations.md | 5 +- ...SPOServicePrioritizationBillingPolicies.md | 5 +- .../Get-SPOSite.md | 142 +- .../Get-SPOSiteCollectionAppCatalogs.md | 22 +- .../Get-SPOSiteContentMoveState.md | 34 +- .../Get-SPOSiteDataEncryptionPolicy.md | 24 +- .../Get-SPOSiteDesign.md | 25 +- .../Get-SPOSiteDesignRights.md | 27 +- .../Get-SPOSiteDesignRun.md | 12 +- .../Get-SPOSiteDesignRunStatus.md | 8 +- .../Get-SPOSiteDesignTask.md | 34 +- ...POSiteFileVersionBatchDeleteJobProgress.md | 18 +- ...eFileVersionExpirationReportJobProgress.md | 24 +- .../Get-SPOSiteGroup.md | 18 +- .../Get-SPOSitePages.md | 166 +- .../Get-SPOSiteRenameState.md | 43 +- .../Get-SPOSiteReview.md | 19 +- .../Get-SPOSiteScript.md | 23 +- .../Get-SPOSiteScriptFromList.md | 23 +- .../Get-SPOSiteScriptFromWeb.md | 63 +- .../Get-SPOSiteScriptPackageFile.md | 92 + .../Get-SPOSiteScriptPackageFromWeb.md | 198 + .../Get-SPOSiteUserInvitations.md | 37 +- .../Get-SPOSiteVersionPolicyJobProgress.md | 16 +- .../Get-SPOStorageEntity.md | 32 +- ...t-SPOStructuralNavigationCacheSiteState.md | 25 +- ...et-SPOStructuralNavigationCacheWebState.md | 22 +- .../Get-SPOTemporarilyDisableAppBar.md | 46 + .../Get-SPOTenant.md | 27 +- .../Get-SPOTenantCdnEnabled.md | 8 +- .../Get-SPOTenantCdnOrigins.md | 8 +- .../Get-SPOTenantCdnPolicies.md | 18 +- ...OTenantContentTypeReplicationParameters.md | 14 +- .../Get-SPOTenantIdentityMappingGroup.md | 78 + .../Get-SPOTenantIdentityMappingUser.md | 78 + .../Get-SPOTenantLogEntry.md | 53 +- .../Get-SPOTenantLogLastAvailableTimeInUtc.md | 10 +- .../Get-SPOTenantPreAuthSettings.md | 6 +- .../Get-SPOTenantRenameSitePrioritization.md | 9 +- .../Get-SPOTenantRenameStatus.md | 18 +- ...et-SPOTenantRestrictedSearchAllowedList.md | 46 + .../Get-SPOTenantRestrictedSearchMode.md | 46 + ...OTenantServicePrincipalPermissionGrants.md | 34 +- ...enantServicePrincipalPermissionRequests.md | 27 +- .../Get-SPOTenantSyncClientRestriction.md | 8 +- ...-SPOTenantTaxonomyReplicationParameters.md | 14 +- .../Get-SPOTheme.md | 37 +- .../Get-SPOUnifiedGroup.md | 20 +- .../Get-SPOUnifiedGroupMoveState.md | 53 +- .../Get-SPOUser.md | 41 +- .../Get-SPOUserAndContentMoveState.md | 52 +- .../Get-SPOUserOneDriveLocation.md | 20 +- .../Get-SPOWebTemplate.md | 18 +- .../Grant-SPOHubSiteRights.md | 34 +- .../Grant-SPOSiteDesignRights.md | 37 +- .../Invoke-SPOListDesign.md | 76 + .../Invoke-SPOMigrationEncryptUploadSubmit.md | 59 +- .../Invoke-SPOSiteDesign.md | 31 +- .../Invoke-SPOSiteSwap.md | 104 +- .../Invoke-SPOSiteUpgrade.md | 138 + ...Microsoft.Online.SharePoint.PowerShell.md} | 10 +- .../New-SPOAppBillingPolicy.md | 75 +- .../New-SPOContainerType.md | 86 +- .../New-SPOListFileVersionBatchDeleteJob.md | 122 +- ...w-SPOListFileVersionExpirationReportJob.md | 76 +- .../New-SPOMigrationEncryptionParameters.md | 16 +- .../New-SPOMigrationPackage.md | 69 +- .../New-SPOPortalLaunchWaves.md | 186 + .../New-SPOPublicCdnOrigin.md | 44 +- .../New-SPOSdnProvider.md | 54 +- ...w-SPOServicePrioritizationBillingPolicy.md | 15 +- .../New-SPOSite.md | 55 +- .../New-SPOSiteFileVersionBatchDeleteJob.md | 103 +- ...w-SPOSiteFileVersionExpirationReportJob.md | 55 +- .../New-SPOSiteGroup.md | 22 +- .../New-SPOSiteSharingReportJob.md | 28 +- .../Register-SPODataEncryptionPolicy.md | 120 +- .../Register-SPOHubSite.md | 37 +- .../Remove-SPOAppBillingPolicy.md | 61 +- ...emove-SPOBlockedPageCreationContentType.md | 94 + .../Remove-SPOContainer.md | 68 +- .../Remove-SPOContainerType.md | 98 +- .../Remove-SPOContainerUser.md | 92 + .../Remove-SPOContentEventEmailAddresses.md | 29 +- .../Remove-SPOContentSecurityPolicy.md | 56 +- .../Remove-SPOCrossTenantRelationship.md} | 54 +- .../Remove-SPODataAccessGovernanceInsight.md | 30 +- .../Remove-SPODeletedContainer.md | 73 +- .../Remove-SPODeletedSite.md | 42 +- .../Remove-SPOExternalUser.md | 32 +- .../Remove-SPOFontPackage.md | 61 + .../Remove-SPOGeoAdministrator.md | 64 +- .../Remove-SPOHomeSite.md | 12 +- .../Remove-SPOHubSiteAssociation.md | 28 +- .../Remove-SPOHubToHubAssociation.md | 22 +- ...formationBarriersPolicyComplianceReport.md | 92 + .../Remove-SPOKnowledgeHubSite.md | 46 + .../Remove-SPOListDesign.md | 12 +- ...Remove-SPOListFileVersionBatchDeleteJob.md | 63 +- .../Remove-SPOMigrationJob.md | 14 +- ...e-SPOMultiGeoCompanyAllowedDataLocation.md | 27 +- .../Remove-SPOOrgAssetsLibrary.md | 54 +- .../Remove-SPOOrgNewsSite.md | 16 +- .../Remove-SPOPortalLaunchWaves.md | 92 + .../Remove-SPOPublicCdnOrigin.md | 48 +- .../Remove-SPOSdnProvider.md | 24 +- ...SPOServicePrioritizationAppRegistration.md | 42 +- .../Remove-SPOSite.md | 44 +- .../Remove-SPOSiteCollectionAppCatalog.md | 18 +- .../Remove-SPOSiteCollectionAppCatalogById.md | 18 +- .../Remove-SPOSiteDesign.md | 33 +- .../Remove-SPOSiteDesignTask.md | 25 +- ...Remove-SPOSiteFileVersionBatchDeleteJob.md | 51 +- .../Remove-SPOSiteGroup.md | 14 +- .../Remove-SPOSiteScript.md | 25 +- .../Remove-SPOSiteSharingReportJob.md | 61 + .../Remove-SPOSiteUserInvitations.md | 40 +- .../Remove-SPOSiteVersionPolicyJob.md | 52 +- .../Remove-SPOStorageEntity.md | 37 +- .../Remove-SPOTenantCdnOrigin.md | 43 +- .../Remove-SPOTenantIdentityMappingGroup.md | 78 + .../Remove-SPOTenantIdentityMappingUser.md | 78 + ...emove-SPOTenantRenameSitePrioritization.md | 6 +- ...ve-SPOTenantRestrictedSearchAllowedList.md | 99 + .../Remove-SPOTenantSyncClientRestriction.md | 4 +- .../Remove-SPOTheme.md | 36 +- .../Remove-SPOUser.md | 16 +- .../Remove-SPOUserInfo.md | 31 +- .../Remove-SPOUserProfile.md | 29 +- .../Repair-SPOSite.md | 56 +- .../Request-SPOPersonalSite.md | 20 +- .../Request-SPOUpgradeEvaluationSite.md | 52 +- .../Restore-SPODataEncryptionPolicy.md | 99 +- .../Restore-SPODeletedContainer.md | 27 +- .../Restore-SPODeletedSite.md | 14 +- .../Revoke-SPOHubSiteRights.md | 27 +- .../Revoke-SPOSiteDesignRights.md | 21 +- ...oke-SPOTenantServicePrincipalPermission.md | 49 +- .../Revoke-SPOUserSession.md | 34 +- .../Set-SPOApplication.md | 66 +- .../Set-SPOApplicationPermission.md | 57 +- .../Set-SPOBlockedPageCreationContentType.md | 93 + .../Set-SPOBrowserIdleSignOut.md | 43 +- .../Set-SPOBuiltInDesignPackageVisibility.md | 15 +- .../Set-SPOBuiltInFontPackageSettings.md | 33 +- .../Set-SPOBuiltInSiteTemplateSettings.md | 66 +- .../Set-SPOContainer.md | 211 +- .../Set-SPOContainerType.md | 93 +- .../Set-SPOContainerTypeConfiguration.md | 107 +- .../Set-SPOContainerUser.md | 92 + .../Set-SPOContentEventEmailAddresses.md | 29 +- .../Set-SPOCopilotPromoOptInStatus.md | 25 +- .../Set-SPOCrossTenantQuota.md | 46 + .../Set-SPOCrossTenantRelationship.md | 35 +- .../Set-SPOCustomFontCatalog.md | 108 + .../Set-SPODisableSpacesActivation.md | 43 +- .../Set-SPOGeoStorageQuota.md | 20 +- .../Set-SPOHideDefaultThemes.md | 10 +- .../Set-SPOHomeSite.md | 46 +- .../Set-SPOHubSite.md | 85 +- .../Set-SPOKnowledgeHubSite.md | 61 + .../Set-SPOListVersionPolicy.md | 101 +- .../Set-SPOMigrationPackageAzureSource.md | 100 +- ...t-SPOMultiGeoCompanyAllowedDataLocation.md | 43 +- .../Set-SPOMultiGeoExperience.md | 31 +- .../Set-SPOOrgAssetsLibrary.md | 76 +- .../Set-SPOOrgNewsSite.md | 19 +- .../Set-SPOPortalLaunchWaves.md | 109 + .../Set-SPORestrictedSiteCreation.md | 87 +- ...SPOServicePrioritizationAppRegistration.md | 13 +- .../Set-SPOSite.md | 1302 +++--- .../Set-SPOSiteArchiveState.md | 100 +- .../Set-SPOSiteDesign.md | 110 +- .../Set-SPOSiteGroup.md | 33 +- .../Set-SPOSiteOffice365Group.md | 103 +- .../Set-SPOSiteScript.md | 54 +- .../Set-SPOSiteScriptPackage.md | 10 +- .../Set-SPOStorageEntity.md | 49 +- ...t-SPOStructuralNavigationCacheSiteState.md | 36 +- ...et-SPOStructuralNavigationCacheWebState.md | 34 +- .../Set-SPOTemporarilyDisableAppBar.md | 61 + .../Set-SPOTenant.md | 3623 ++++++++--------- .../Set-SPOTenantCdnEnabled.md | 42 +- .../Set-SPOTenantCdnPolicy.md | 19 +- ...OTenantContentTypeReplicationParameters.md | 30 +- .../Set-SPOTenantPreAuthSettings.md | 60 +- .../Set-SPOTenantRenameSitePrioritization.md | 9 +- .../Set-SPOTenantRestrictedSearchMode.md | 62 + .../Set-SPOTenantSyncClientRestriction.md | 58 +- ...-SPOTenantTaxonomyReplicationParameters.md | 30 +- .../Set-SPOUnifiedGroup.md | 31 +- .../Set-SPOUser.md | 23 +- .../Set-SPOWebTheme.md | 32 +- ...OAuditDataCollectionForActivityInsights.md | 11 +- .../Start-SPOCopilotAgentInsightsReport.md | 75 +- .../Start-SPOCrossTenantGroupContentMove.md | 153 + .../Start-SPOCrossTenantSiteContentMove.md | 153 + .../Start-SPOCrossTenantUserContentMove.md | 153 + .../Start-SPODataAccessGovernanceInsight.md | 112 +- .../Start-SPOEnterpriseAppInsightsReport.md | 77 +- ...rt-SPOInformationBarriersInsightsReport.md | 17 +- ...formationBarriersPolicyComplianceReport.md | 93 + ...art-SPORestrictedAccessForSitesInsights.md | 87 +- ...ORestrictedContentDiscoverabilityReport.md | 92 + .../Start-SPOSiteContentMove.md | 116 +- ...SiteOpticalCharacterRecognitionBackfill.md | 60 +- .../Start-SPOSiteRename.md | 130 +- .../Start-SPOSiteReview.md | 14 +- .../Start-SPOTenantRename.md | 57 +- .../Start-SPOUnifiedGroupMove.md | 39 +- .../Start-SPOUserAndContentMove.md | 63 +- ...OAuditDataCollectionForActivityInsights.md | 11 +- .../Stop-SPOCrossTenantGroupContentMove.md | 61 + .../Stop-SPOCrossTenantSiteContentMove.md | 61 + .../Stop-SPOCrossTenantUserContentMove.md | 61 + .../Stop-SPOSiteContentMove.md | 10 +- .../Stop-SPOTenantRename.md | 41 +- .../Stop-SPOUserAndContentMove.md | 16 +- .../Submit-SPOMigrationJob.md | 38 +- .../Test-SPOSite.md | 16 +- ...Unlock-SPOSensitivityLabelEncryptedFile.md | 37 +- .../Unregister-SPOHubSite.md | 58 +- .../Update-SPODataEncryptionPolicy.md | 85 +- .../Update-UserType.md | 10 +- .../Verify-SPOCrossTenantRelationship.md} | 54 +- .../Disable-SPOTenantServicePrincipal.md | 40 - .../Get-SPOCopilotPromoOptInStatus.md | 41 - .../Get-SPOCopilotPromoUsage.md | 42 - .../New-SPODataConnectionSetting.md | 205 - ...ncipalManagementServiceApplicationProxy.md | 160 - .../Remove-SPODataConnectionSetting.md | 211 - .../Set-SPODataConnectionSetting.md | 296 -- .../Set-SPODataConnectionSettingMetadata.md | 260 -- .../sharepoint-online/Upgrade-SPOSite.md | 172 - 342 files changed, 15102 insertions(+), 8148 deletions(-) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOContainerTypeBilling.md (78%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerUser.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOContentSecurityPolicy.md (65%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOGeoAdministrator.md (87%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOHubSiteAssociation.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOHubToHubAssociation.md (87%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOListDesign.md (93%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOOrgAssetsLibrary.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOServicePrioritizationAppRegistration.md (85%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOSiteCollectionAppCatalog.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOSiteDesign.md (71%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOSiteDesignTask.md (85%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteOneDriveClassicFeatures.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOSiteScript.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOSiteScriptPackage.md (97%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOTenantCdnOrigin.md (88%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMap.md rename sharepoint/sharepoint-ps/{sharepoint-online/New-SPOTenantOrgRelation.md => Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingGroup.md} (53%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingUser.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantRestrictedSearchAllowedList.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOTheme.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Add-SPOUser.md (80%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Apply-SPOFontPackage.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Approve-SPOTenantServicePrincipalPermissionGrant.md (51%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Approve-SPOTenantServicePrincipalPermissionRequest.md (53%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Clear-SPOTenantPreAuthSettings.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Connect-SPOService.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/ConvertTo-SPOMigrationEncryptedPackage.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/ConvertTo-SPOMigrationTargetedPackage.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Copy-SPOPersonalSitePage.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Deny-SPOTenantServicePrincipalPermissionRequest.md (54%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Disable-SPOTenantServicePrincipal.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Disconnect-SPOService.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Enable-SPOCommSite.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Enable-SPOTenantServicePrincipal.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Export-SPODataAccessGovernanceInsight.md (89%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Export-SPOQueryLogs.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online/Get-SPOTenantOrgRelationByPartner.md => Microsoft.Online.SharePoint.PowerShell/Export-SPOSites.md} (52%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Export-SPOUserInfo.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Export-SPOUserProfile.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-FileSensitivityLabelInfo.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOAppBillingPolicies.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOAppErrors.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOAppInfo.md (85%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOApplication.md (90%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOAuditDataCollectionStatusForActivityInsights.md (82%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBlockedPageCreationContentTypeList.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOBrowserIdleSignOut.md (89%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOBuiltInDesignPackageVisibility.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOBuiltInFontPackageSettings.md (55%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOBuiltInSiteTemplateSettings.md (60%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOContainer.md (72%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOContainerType.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOContainerTypeConfiguration.md (70%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOContentEventEmailAddresses.md (66%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOContentSecurityPolicy.md (60%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOCopilotAgentInsightsReport.md (93%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoOptInStatus.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoUsage.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOCrossGeoMoveReport.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOCrossGeoMovedUsers.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOCrossGeoUsers.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOCrossTenantCompatibilityStatus.md (79%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantGroupContentMoveState.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOCrossTenantHostUrl.md (76%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationship.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByPartner.md rename sharepoint/sharepoint-ps/{sharepoint-online/Get-SPOTenantOrgRelationByScenario.md => Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByScenario.md} (63%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantSiteContentMoveState.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantUserContentMoveState.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPODataAccessGovernanceInsight.md (90%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPODataEncryptionPolicy.md (91%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPODeletedContainer.md (91%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPODeletedSite.md (81%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODisableSpacesActivation.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOEnterpriseAppInsightsReport.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOExternalUser.md (84%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOFontPackage.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOGeoAdministrator.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOGeoMoveCrossCompatibilityStatus.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOGeoStorageQuota.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOHideDefaultThemes.md (63%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOHomeSite.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOHubSite.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOInformationBarriersInsightsReport.md (81%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md rename sharepoint/sharepoint-ps/{sharepoint-online/Get-SPOTenantOrgRelation.md => Microsoft.Online.SharePoint.PowerShell/Get-SPOIsCommSite.md} (53%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOKnowledgeHubSite.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOLandingSites.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOListDesign.md (96%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOListFileVersionBatchDeleteJobProgress.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOListFileVersionExpirationReportJobProgress.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOListVersionPolicy.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOMalwareFile.md (76%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOMalwareFileContent.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOMigrationJobProgress.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOMigrationJobStatus.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOMultiGeoCompanyAllowedDataLocation.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOMultiGeoExperience.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOOrgAssetsLibrary.md (64%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOOrgNewsSite.md (94%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOPersonalSitePageCopyProgress.md (82%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPortalLaunchWaves.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOPublicCdnOrigins.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPORestrictedAccessForSitesInsights.md (84%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedContentDiscoverabilityReport.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPORestrictedSiteCreation.md (77%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOServicePrioritizationAppRegistrations.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOServicePrioritizationBillingPolicies.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSite.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteCollectionAppCatalogs.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteContentMoveState.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteDataEncryptionPolicy.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteDesign.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteDesignRights.md (63%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteDesignRun.md (91%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteDesignRunStatus.md (93%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteDesignTask.md (77%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteFileVersionBatchDeleteJobProgress.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteFileVersionExpirationReportJobProgress.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteGroup.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSitePages.md (76%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteRenameState.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteReview.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteScript.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteScriptFromList.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteScriptFromWeb.md (83%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFile.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFromWeb.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteUserInvitations.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOSiteVersionPolicyJobProgress.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOStorageEntity.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOStructuralNavigationCacheSiteState.md (76%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOStructuralNavigationCacheWebState.md (77%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTemporarilyDisableAppBar.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenant.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantCdnEnabled.md (90%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantCdnOrigins.md (90%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantCdnPolicies.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantContentTypeReplicationParameters.md (93%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingGroup.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingUser.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantLogEntry.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantLogLastAvailableTimeInUtc.md (77%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantPreAuthSettings.md (95%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantRenameSitePrioritization.md (89%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantRenameStatus.md (85%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchAllowedList.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchMode.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantServicePrincipalPermissionGrants.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantServicePrincipalPermissionRequests.md (65%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantSyncClientRestriction.md (91%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTenantTaxonomyReplicationParameters.md (94%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOTheme.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOUnifiedGroup.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOUnifiedGroupMoveState.md (68%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOUser.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOUserAndContentMoveState.md (85%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOUserOneDriveLocation.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Get-SPOWebTemplate.md (85%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Grant-SPOHubSiteRights.md (72%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Grant-SPOSiteDesignRights.md (68%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOListDesign.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Invoke-SPOMigrationEncryptUploadSubmit.md (77%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Invoke-SPOSiteDesign.md (76%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Invoke-SPOSiteSwap.md (90%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteUpgrade.md rename sharepoint/sharepoint-ps/{sharepoint-online/sharepoint-online.md => Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md} (99%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOAppBillingPolicy.md (76%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOContainerType.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOListFileVersionBatchDeleteJob.md (68%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOListFileVersionExpirationReportJob.md (66%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOMigrationEncryptionParameters.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOMigrationPackage.md (77%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPortalLaunchWaves.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOPublicCdnOrigin.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOSdnProvider.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOServicePrioritizationBillingPolicy.md (85%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOSite.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOSiteFileVersionBatchDeleteJob.md (71%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOSiteFileVersionExpirationReportJob.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOSiteGroup.md (77%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/New-SPOSiteSharingReportJob.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Register-SPODataEncryptionPolicy.md (66%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Register-SPOHubSite.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOAppBillingPolicy.md (56%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOBlockedPageCreationContentType.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOContainer.md (67%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOContainerType.md (59%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerUser.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOContentEventEmailAddresses.md (70%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOContentSecurityPolicy.md (50%) rename sharepoint/sharepoint-ps/{sharepoint-online/Remove-SPOTenantOrgRelation.md => Microsoft.Online.SharePoint.PowerShell/Remove-SPOCrossTenantRelationship.md} (56%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPODataAccessGovernanceInsight.md (90%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPODeletedContainer.md (64%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPODeletedSite.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOExternalUser.md (82%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOGeoAdministrator.md (63%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOHomeSite.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOHubSiteAssociation.md (60%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOHubToHubAssociation.md (81%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOInformationBarriersPolicyComplianceReport.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOKnowledgeHubSite.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOListDesign.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOListFileVersionBatchDeleteJob.md (66%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOMigrationJob.md (92%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOMultiGeoCompanyAllowedDataLocation.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOOrgAssetsLibrary.md (61%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOOrgNewsSite.md (91%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPortalLaunchWaves.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOPublicCdnOrigin.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSdnProvider.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOServicePrioritizationAppRegistration.md (64%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSite.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteCollectionAppCatalog.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteCollectionAppCatalogById.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteDesign.md (53%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteDesignTask.md (67%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteFileVersionBatchDeleteJob.md (67%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteGroup.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteScript.md (69%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteSharingReportJob.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteUserInvitations.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOSiteVersionPolicyJob.md (65%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOStorageEntity.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOTenantCdnOrigin.md (90%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingGroup.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingUser.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOTenantRenameSitePrioritization.md (93%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantRestrictedSearchAllowedList.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOTenantSyncClientRestriction.md (96%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOTheme.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOUser.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOUserInfo.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Remove-SPOUserProfile.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Repair-SPOSite.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Request-SPOPersonalSite.md (89%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Request-SPOUpgradeEvaluationSite.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Restore-SPODataEncryptionPolicy.md (63%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Restore-SPODeletedContainer.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Restore-SPODeletedSite.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Revoke-SPOHubSiteRights.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Revoke-SPOSiteDesignRights.md (63%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Revoke-SPOTenantServicePrincipalPermission.md (70%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Revoke-SPOUserSession.md (91%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOApplication.md (90%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOApplicationPermission.md (88%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBlockedPageCreationContentType.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOBrowserIdleSignOut.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOBuiltInDesignPackageVisibility.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOBuiltInFontPackageSettings.md (51%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOBuiltInSiteTemplateSettings.md (75%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOContainer.md (76%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOContainerType.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOContainerTypeConfiguration.md (82%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerUser.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOContentEventEmailAddresses.md (69%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOCopilotPromoOptInStatus.md (66%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantQuota.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOCrossTenantRelationship.md (75%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCustomFontCatalog.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPODisableSpacesActivation.md (88%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOGeoStorageQuota.md (87%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOHideDefaultThemes.md (89%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOHomeSite.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOHubSite.md (70%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOKnowledgeHubSite.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOListVersionPolicy.md (89%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOMigrationPackageAzureSource.md (76%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOMultiGeoCompanyAllowedDataLocation.md (75%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOMultiGeoExperience.md (77%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOOrgAssetsLibrary.md (68%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOOrgNewsSite.md (85%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOPortalLaunchWaves.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPORestrictedSiteCreation.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOServicePrioritizationAppRegistration.md (84%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOSite.md (79%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOSiteArchiveState.md (52%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOSiteDesign.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOSiteGroup.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOSiteOffice365Group.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOSiteScript.md (74%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOSiteScriptPackage.md (95%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOStorageEntity.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOStructuralNavigationCacheSiteState.md (70%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOStructuralNavigationCacheWebState.md (73%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTemporarilyDisableAppBar.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenant.md (59%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenantCdnEnabled.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenantCdnPolicy.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenantContentTypeReplicationParameters.md (92%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenantPreAuthSettings.md (92%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenantRenameSitePrioritization.md (92%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantRestrictedSearchMode.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenantSyncClientRestriction.md (92%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOTenantTaxonomyReplicationParameters.md (92%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOUnifiedGroup.md (72%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOUser.md (80%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Set-SPOWebTheme.md (77%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOAuditDataCollectionForActivityInsights.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOCopilotAgentInsightsReport.md (65%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantGroupContentMove.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantSiteContentMove.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantUserContentMove.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPODataAccessGovernanceInsight.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOEnterpriseAppInsightsReport.md (66%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOInformationBarriersInsightsReport.md (78%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPORestrictedAccessForSitesInsights.md (62%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedContentDiscoverabilityReport.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOSiteContentMove.md (78%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOSiteOpticalCharacterRecognitionBackfill.md (60%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOSiteRename.md (72%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOSiteReview.md (93%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOTenantRename.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOUnifiedGroupMove.md (81%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Start-SPOUserAndContentMove.md (83%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Stop-SPOAuditDataCollectionForActivityInsights.md (82%) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantGroupContentMove.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantSiteContentMove.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantUserContentMove.md rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Stop-SPOSiteContentMove.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Stop-SPOTenantRename.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Stop-SPOUserAndContentMove.md (92%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Submit-SPOMigrationJob.md (89%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Test-SPOSite.md (82%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Unlock-SPOSensitivityLabelEncryptedFile.md (64%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Unregister-SPOHubSite.md (72%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Update-SPODataEncryptionPolicy.md (67%) rename sharepoint/sharepoint-ps/{sharepoint-online => Microsoft.Online.SharePoint.PowerShell}/Update-UserType.md (86%) rename sharepoint/sharepoint-ps/{sharepoint-online/Verify-SPOTenantOrgRelation.md => Microsoft.Online.SharePoint.PowerShell/Verify-SPOCrossTenantRelationship.md} (56%) delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Disable-SPOTenantServicePrincipal.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoOptInStatus.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoUsage.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md delete mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Upgrade-SPOSite.md diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOContainerTypeBilling.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOContainerTypeBilling.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md index fba8fd8dc..65994f62b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOContainerTypeBilling.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerTypeBilling.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spocontainertypebilling applicable: SharePoint Online @@ -14,22 +14,20 @@ ms.reviewer: ## SYNOPSIS -Adds the mentioned billing profile details to a standard container type. +Adds the mentioned billing profile details to a standard container type. ## SYNTAX -### ParamSet1 - -```powershell -Add-SPOContainerTypeBilling –ContainerTypeId -AzureSubscriptionId -ResourceGroup -Region ``` - +Add-SPOContainerTypeBilling -ContainerTypeId -AzureSubscriptionId -ResourceGroup + -Region [] +``` ## DESCRIPTION This cmdlet attaches the Azure subscription ID, resource group and region with the container type ID provided. -You must be a SharePoint Embedded Administrator to run this cmdlet. You also need to have owner or contributor permissions on an Azure subscription, with active time bound permission on billing, and on the Resource group. +You must be a SharePoint Embedded Administrator to run this cmdlet. You also need to have owner or contributor permissions on an Azure subscription, with active time bound permission on billing, and on the Resource group. If you don't have an Azure subscription, follow steps here to [create a subscription](/azure/cloud-adoption-framework/ready/azure-best-practices/initial-subscriptions). @@ -45,18 +43,18 @@ Add-SPOContainerTypeBilling - ContainerTypeId aa1d89b3 -AzureSubscriptionId 5a8a Example 1 attaches the billing profile of Azure subscription ID "5a8a4d9f", resource group "RG100" and region "(US) East US" to the container type ID "aa1d89b3". - ## PARAMETERS -### -ContainerTypeId - -This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. +### -AzureSubscriptionId + +This parameter describes the Azure subscription ID to which the container type needs to be associated. + ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online - + Required: True Position: Named Default value: None @@ -64,48 +62,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AzureSubscriptionId +### -ContainerTypeId -This parameter describes the Azure subscription ID to which the container type needs to be associated. +This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. ```yaml -Type: String -Parameter Sets: +Type: System.Guid +Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Region -### -ResourceGroup - -This parameter describes the resource group to be used for the associated container type. +This parameter describes the region to which the billing profile of the container type is associated with. ```yaml -Type: String -Parameter Sets: +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Region +### -ResourceGroup -This parameter describes the region to which the billing profile of the container type is associated with. +This parameter describes the resource group to be used for the associated container type. ```yaml -Type: String -Parameter Sets: ParamSet2, ParamSet3 +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -116,6 +113,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerUser.md new file mode 100644 index 000000000..785f1aa2b --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContainerUser.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Add-SPOContainerUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Add-SPOContainerUser [-ContainerId] -LoginName -Role [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContainerId +{{ Fill ContainerId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginName +{{ Fill LoginName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +{{ Fill Role Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Owner, Reader, Writer, Manager + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOContentSecurityPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md similarity index 65% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOContentSecurityPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md index b84bcae35..abe7727d6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOContentSecurityPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOContentSecurityPolicy.md @@ -1,5 +1,5 @@ --- -external help file: +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/add-spocontentsecuritypolicy applicable: SharePoint Online @@ -19,18 +19,18 @@ Adds a source to the **Content Security Policy** configuration. ## SYNTAX -### Default - -```powershell -Add-SPOContentSecurityPolicy [-Source] +``` +Add-SPOContentSecurityPolicy [-Source] [] ``` ## DESCRIPTION -Adds a source to the **Content Security Policy** configuration. +Adds a source to the **Content Security Policy** configuration. The source will be added to the `script-src` directive during construction of the `Content-Security-Policy` header. In multi-geo environments, **Content Security Policy** configuration is unique to each geo. +## EXAMPLES + ## PARAMETERS ### -Source @@ -38,7 +38,7 @@ In multi-geo environments, **Content Security Policy** configuration is unique t Source to be added to the **Content Security Policy** configuration. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -50,6 +50,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOContentSecurityPolicy](Get-SPOContentSecurityPolicy.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md new file mode 100644 index 000000000..e685efd5d --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOFontPackage.md @@ -0,0 +1,91 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Add-SPOFontPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Add-SPOFontPackage -Title [-IsHidden ] -PackageJson [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -IsHidden +{{ Fill IsHidden Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PackageJson +{{ Fill PackageJson Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Title +{{ Fill Title Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Boolean + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md similarity index 87% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md index 8bf31b220..8d8f7975f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOGeoAdministrator.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spogeoadministrator applicable: SharePoint Online @@ -56,7 +56,7 @@ Adds the user **admin\@contoso.onmicrosoft.com** as administrator to the SharePo 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: String +Type: System.String Parameter Sets: Group Aliases: Applicable: SharePoint Online @@ -70,10 +70,10 @@ Accept wildcard characters: False ### -ObjectId -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](https://learn.microsoft.com/office365/enterprise/add-a-sharepoint-geo-admin). +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: Guid +Type: System.Guid Parameter Sets: ObjectId Aliases: Applicable: SharePoint Online @@ -90,7 +90,7 @@ Accept wildcard characters: False UserPrincipalName or UPN defined for the specific user on the SharePoint Online tenant. ```yaml -Type: String +Type: System.String Parameter Sets: User Aliases: Applicable: SharePoint Online @@ -108,13 +108,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md index bcc1deef1..c0a40bbd7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubSiteAssociation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spohubsiteassociation applicable: SharePoint Online @@ -18,7 +18,7 @@ Associates a site with a hub site. ## SYNTAX -```powershell +``` Add-SPOHubSiteAssociation [-Site] -HubSite [] ``` @@ -38,37 +38,37 @@ This example associates the research site with the marketing hub site. ## PARAMETERS -### -Site +### -HubSite -URL of the site to join to the hub site. +URL or Site ID of the hub site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -HubSite +### -Site -URL or Site ID of the hub site. +URL of the site to join to the hub site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -76,6 +76,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + ## NOTES If the site or hub site doesn't exist, this cmdlet returns a "File not found" error. @@ -83,3 +91,5 @@ If the site or hub site doesn't exist, this cmdlet returns a "File not found" er If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error. In multi-geo situations, when assigning a hub that is across geo locations, you must pass the site ID of the hub site to the HubSite parameter as a URL will fail. + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubToHubAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubToHubAssociation.md similarity index 87% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubToHubAssociation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubToHubAssociation.md index e2330a6c8..01703065c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubToHubAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOHubToHubAssociation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spohubtohubassociation applicable: SharePoint Online @@ -19,8 +19,8 @@ Note: This feature is currently in preview and may not be available in your tena ## SYNTAX -```powershell -Add-SPOHubToHubAssociation [-Source] -Target [] +``` +Add-SPOHubToHubAssociation [-Source] -Target [] ``` ## DESCRIPTION @@ -44,7 +44,7 @@ This example associates the source hub site with the HubSiteId 7b6fd3a3-b029-4eb HubSiteId of the Source Hub site to be associated with the Target Hub Site. ```yaml -Type: SpoHubSitePipeBind +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -60,7 +60,7 @@ Accept wildcard characters: False HubSiteId of the Target Hub to associate the source Hub to. ```yaml -Type: SpoHubSitePipeBind +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -75,5 +75,17 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### System.Guid + +## OUTPUTS + +### System.Object + ## NOTES + SPOHubToHubAssociation is just a placeholder and not yet ready for production. + +## RELATED LINKS + diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOListDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOListDesign.md similarity index 93% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOListDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOListDesign.md index b7fccab21..4dfd316ba 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOListDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOListDesign.md @@ -49,7 +49,7 @@ This example creates a new list or document library design. The display description of the list or document library design. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -64,7 +64,7 @@ Accept wildcard characters: False Default color associated with the list when creating the list. ```yaml -Type: SPOListDesignColor +Type: Microsoft.Online.SharePoint.PowerShell.SPOListDesignColor Parameter Sets: (All) Aliases: Accepted values: DarkRed, Red, Orange, Green, DarkGreen, Teal, Blue, NavyBlue, BluePurple, DarkBlue, Lavendar, Pink @@ -80,7 +80,7 @@ Accept wildcard characters: False Default icon associated with the list when creating the list. ```yaml -Type: SPOListDesignIcon +Type: Microsoft.Online.SharePoint.PowerShell.SPOListDesignIcon Parameter Sets: (All) Aliases: Accepted values: Bug, Calendar, BullseyeTarget, ClipboardList, Airplane, Rocket, Color, Insights, CubeShape, TestBeakerSolid, Robot, Savings @@ -96,7 +96,7 @@ Accept wildcard characters: False An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. ```yaml -Type: SPOSiteScriptPipeBind[] +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind[] Parameter Sets: (All) Aliases: @@ -111,7 +111,7 @@ Accept wildcard characters: False Set of features that the template comes with. It is displayed as a bulleted list when the user is looking at the template preview in the list or document library creation dialog. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -126,7 +126,7 @@ Accept wildcard characters: False The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -141,7 +141,7 @@ Accept wildcard characters: False The display name of the list or document library design. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOOrgAssetsLibrary.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md index 8b155404c..9f39fc2fc 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOOrgAssetsLibrary.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spoorgassetslibrary applicable: SharePoint Online @@ -19,8 +19,10 @@ Designates a library to be used as a central location for organization assets ac ## SYNTAX -```powershell -Add-SPOOrgAssetsLibrary -LibraryUrl [-ThumbnailUrl ] [-OrgAssetType ] [-CdnType ] [] +``` +Add-SPOOrgAssetsLibrary -LibraryUrl [-ThumbnailUrl ] [-OrgAssetType ] + [-CdnType ] [-NoDefaultOrigins] [-CopilotSearchable ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -53,7 +55,7 @@ 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). ```yaml -Type: SPOTenantCdnType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -66,12 +68,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CopilotSearchable +{{ Fill CopilotSearchable Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LibraryUrl Indicates the absolute URL of the library to be designated as a central location for organization assets. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -83,6 +100,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoDefaultOrigins +{{ Fill NoDefaultOrigins Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OrgAssetType Indicates the type of content in this library. Currently supported values are "ImageDocumentLibrary" and "OfficeTemplateLibrary". @@ -93,11 +125,10 @@ OfficeTemplateLibrary is the suggested type for Office files and will show up in In order to benefit from both UIs you can choose "ImageDocumentLibrary,OfficeTemplateLibrary" as OrgAssetType. ```yaml -Type: OrgAssetType +Type: Microsoft.Online.SharePoint.PowerShell.OrganizationAssetType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online -Accepted values: ImageDocumentLibrary, OfficeTemplateLibrary +Accepted values: ImageDocumentLibrary, OfficeTemplateLibrary, OfficeFontLibrary, BrandKitLibrary Required: False Position: Named @@ -111,7 +142,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -123,20 +154,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Get-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/get-spoorgassetslibrary?view=sharepoint-ps) +[Get-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/get-spoorgassetslibrary) -[Set-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/set-spoorgassetslibrary?view=sharepoint-ps) +[Set-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/set-spoorgassetslibrary) -[Remove-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spoorgassetslibrary?view=sharepoint-ps) +[Remove-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/remove-spoorgassetslibrary) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOServicePrioritizationAppRegistration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOServicePrioritizationAppRegistration.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOServicePrioritizationAppRegistration.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOServicePrioritizationAppRegistration.md index e1741172c..acc6d0d47 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOServicePrioritizationAppRegistration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOServicePrioritizationAppRegistration.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Add-SPOServicePrioritizationAppRegistration applicable: SharePoint Online @@ -41,7 +41,7 @@ This example adds a new app registration with the specified AppId and PolicyId, Specifies the unique identifier (GUID) of the app registration to be added. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -56,7 +56,7 @@ Accept wildcard characters: False Specifies the unique identifier (GUID) of the policy to associate with the app registration. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -71,7 +71,7 @@ Accept wildcard characters: False This parameter specifies the quota multiplier limit for the scaling feature. Value must be between 2 and 10. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -83,7 +83,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -92,6 +92,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteCollectionAppCatalog.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md index 81ca9fbe4..005637d7d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteCollectionAppCatalog.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteCollectionAppCatalog.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spositecollectionappcatalog applicable: SharePoint Online @@ -18,7 +18,7 @@ Adds a Site Collection scoped App Catalog to a site. ## SYNTAX -```powershell +``` Add-SPOSiteCollectionAppCatalog -Site [-WhatIf] [-Confirm] [] ``` @@ -46,7 +46,7 @@ This example adds a SiteCollection app catalog to the specified site. Url of the site to add the app catalog to. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -64,7 +64,7 @@ Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -82,7 +82,7 @@ Displays a message that describes the effect of the command instead of executing For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -98,4 +98,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md similarity index 71% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md index 6485a8fa3..4d8a8d11c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesign.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spositedesign applicable: SharePoint Online @@ -18,17 +18,10 @@ Creates a new site design available to users when they create a new site from th ## SYNTAX -```powershell -Add-SPOSiteDesign - -Title - -WebTemplate - -SiteScripts - [-Description ] - [-ThumbnailUrl ] - [-PreviewImageUrl ] - [-PreviewImageAltText ] - [-IsDefault] - [] +``` +Add-SPOSiteDesign -Title -WebTemplate -SiteScripts + [-Description ] [-ThumbnailUrl ] [-PreviewImageUrl ] [-PreviewImageAltText ] + [-IsDefault] [-DesignPackageId ] [] ``` ## DESCRIPTION @@ -49,66 +42,80 @@ Add-SPOSiteDesign ` -Description "Tracks key customer data in a list" ` -ThumbnailUrl "https://contoso.sharepoint.com/SiteAssets/site-thumbnail.png" ` -PreviewImageUrl "https://contoso.sharepoint.com/SiteAssets/site-preview.png" ` - -PreviewImageAltText "site preview" + -PreviewImageAltText "site preview" ``` ## PARAMETERS -### -Title +### -Description -The display name of the site design. +The display description of the site design. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WebTemplate +### -DesignPackageId +{{ Fill DesignPackageId Description }} -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](https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview). +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDefault + +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: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteScripts +### -PreviewImageAltText -An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. +The alt text description of the image for accessibility. ```yaml -Type: SPOSiteScriptPipeBind[] +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -PreviewImageUrl -The display description of the site design. +The URL of a preview image. If none is specified, SharePoint uses a generic image. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -119,28 +126,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThumbnailUrl +### -SiteScripts -The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. +An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PreviewImageUrl +### -ThumbnailUrl -The URL of a preview image. If none is specified, SharePoint uses a generic image. +The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -151,42 +158,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreviewImageAltText +### -Title -The alt text description of the image for accessibility. +The display name of the site design. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsDefault +### -WebTemplate -A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](https://learn.microsoft.com/sharepoint/dev/declarative-customization/customize-default-site-design). +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). ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesignTask.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesignTask.md index 5f1456ee2..549e03d1d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteDesignTask.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spositedesigntask applicable: SharePoint Online @@ -20,8 +20,8 @@ The supported site templates you can apply a site design to include: "modern" te ## SYNTAX -```powershell -Add-SPOSiteDesignTask -SiteDesignId -WebUrl [] +``` +Add-SPOSiteDesignTask [-SiteDesignId] [-WebUrl] [] ``` ## DESCRIPTION @@ -50,12 +50,12 @@ Add-SPOSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl The ID of the site design to apply. ```yaml -Type: SPOSiteDesignPipeBind +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -66,12 +66,12 @@ Accept wildcard characters: False The URL of the site collection where the site design will be applied. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -83,12 +83,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Get-SPOSiteDesignTask](https://learn.microsoft.com/powershell/module/sharepoint-online/get-spositedesigntask?view=sharepoint-ps) +[Get-SPOSiteDesignTask](/powershell/module/sharepoint-online/get-spositedesigntask) -[Invoke-SPOSiteDesign](https://learn.microsoft.com/powershell/module/sharepoint-online/invoke-spositedesign?view=sharepoint-ps) +[Invoke-SPOSiteDesign](/powershell/module/sharepoint-online/invoke-spositedesign) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteOneDriveClassicFeatures.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteOneDriveClassicFeatures.md new file mode 100644 index 000000000..a639f7f33 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteOneDriveClassicFeatures.md @@ -0,0 +1,115 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Add-SPOSiteOneDriveClassicFeatures + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### SingleUserLoginParamSet (Default) +``` +Add-SPOSiteOneDriveClassicFeatures [-UserLogin] [-Scope] [-FeatureIds] + [] +``` + +### UserLoginFilePathParamSet +``` +Add-SPOSiteOneDriveClassicFeatures [-UserLoginFilePath] [-Scope] [-FeatureIds] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -FeatureIds +{{ Fill FeatureIds Description }} + +```yaml +Type: System.Guid[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Scope +{{ Fill Scope Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.FeatureScope +Parameter Sets: (All) +Aliases: +Accepted values: Site, Web + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLogin +{{ Fill UserLogin Description }} + +```yaml +Type: System.String +Parameter Sets: SingleUserLoginParamSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserLoginFilePath +{{ Fill UserLoginFilePath Description }} + +```yaml +Type: System.String +Parameter Sets: UserLoginFilePathParamSet +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScript.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScript.md index 11eb8eea4..62a029798 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScript.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spositescript applicable: SharePoint Online @@ -18,8 +18,8 @@ Uploads a new site script for use either directly or in a site design. ## SYNTAX -```powershell -Add-SPOSiteScript -Title -Content [-Description ] [] +``` +Add-SPOSiteScript -Title -Content [-Description ] [] ``` ## DESCRIPTION @@ -85,48 +85,48 @@ Add-SPOSiteDesign -Title "Communication Site with External Users and Guest Shari ## PARAMETERS -### -Title +### -Content -The display name of the site design. +The JSON value that describes the script. For more information, see the [JSON reference](/sharepoint/dev/declarative-customization/site-design-json-schema). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Content +### -Description -The JSON value that describes the script. For more information, see the [JSON reference](https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema). +A description of the script. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Title -A description of the script. +The display name of the site design. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -139,8 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### System.String + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScriptPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScriptPackage.md similarity index 97% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScriptPackage.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScriptPackage.md index d46b2a1ac..8d7c35092 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScriptPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOSiteScriptPackage.md @@ -54,7 +54,7 @@ This example adds a site script package as a zip file containing a manifest.json The absolute path to a zip archive file containing the content of the new site script package. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -69,7 +69,7 @@ Accept wildcard characters: False A description of the site script. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -84,7 +84,7 @@ Accept wildcard characters: False The display name of the site script. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md index 70fac8037..864c84bde 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantCdnOrigin.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spotenantcdnorigin applicable: SharePoint Online @@ -18,8 +18,9 @@ Configures a new origin to public or private content delivery network (CDN). Req ## SYNTAX -```powershell -Add-SPOTenantCdnOrigin -CdnType [-Confirm] -OriginUrl [-WhatIf] [] +``` +Add-SPOTenantCdnOrigin -OriginUrl -CdnType [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -45,7 +46,7 @@ This example configures a public CDN on a site level. Specifies the CDN type. The valid values are: public or private. ```yaml -Type: SPOTenantCdnType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private @@ -58,35 +59,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -OriginUrl -Prompts you for confirmation before running the cmdlet. +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. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online -Required: False + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OriginUrl - -Specifies a path to the doc library to be configured. It can be provided in two ways: relative path, or a mask. +### -Confirm -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. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online - -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -99,7 +100,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMap.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMap.md new file mode 100644 index 000000000..e87f67c48 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMap.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Add-SPOTenantIdentityMap + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Add-SPOTenantIdentityMap [-IdentityMapPath] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -IdentityMapPath +{{ Fill IdentityMapPath Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingGroup.md similarity index 53% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOTenantOrgRelation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingGroup.md index fa71e15cf..02072016a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOTenantOrgRelation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingGroup.md @@ -1,35 +1,29 @@ --- -external help file: sharepointonline.xml +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/New-SPOTenantOrgRelation -applicable: SharePoint Online -title: New-SPOTenantOrgRelation +online version: schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: --- -# New-SPOTenantOrgRelation +# Add-SPOTenantIdentityMappingGroup ## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. +{{ Fill in the Synopsis }} ## SYNTAX -```poowershell -New-SPOTenantOrgRelation [-Scenario] [-PartnerRole] [-PartnerCompanyId] [-PartnerInstanceId ] [-PartnerSiteSubscriptionId ] [] +``` +Add-SPOTenantIdentityMappingGroup [-SourceTenantCompanyId] [-SourceGroupObjectId] + [-TargetGroupObjectId] [-TargetGroupName] [-GroupType] + [] ``` ## DESCRIPTION - {{ Fill in the Description }} ## EXAMPLES ### Example 1 - ```powershell PS C:\> {{ Add example code here }} ``` @@ -38,91 +32,84 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} +### -GroupType +{{ Fill GroupType Description }} ```yaml -Type: Guid +Type: Microsoft.SharePoint.Client.Administration.TenantIdentityMappingGroupType Parameter Sets: (All) Aliases: +Accepted values: None, RegularGroup, AdminGroup, O365Group Required: True -Position: 2 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PartnerInstanceId - -{{ Fill PartnerInstanceId Description }} +### -SourceGroupObjectId +{{ Fill SourceGroupObjectId Description }} ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PartnerRole - -{{ Fill PartnerRole Description }} +### -SourceTenantCompanyId +{{ Fill SourceTenantCompanyId Description }} ```yaml -Type: OrgRelationRole +Type: System.Guid Parameter Sets: (All) Aliases: -Accepted values: None, Source, Target Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PartnerSiteSubscriptionId - -{{ Fill PartnerSiteSubscriptionId Description }} +### -TargetGroupName +{{ Fill TargetGroupName Description }} ```yaml -Type: Guid +Type: System.String Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Scenario - -{{ Fill Scenario Description }} +### -TargetGroupObjectId +{{ Fill TargetGroupObjectId Description }} ```yaml -Type: OrgRelationScenario +Type: System.Guid Parameter Sets: (All) Aliases: -Accepted values: None, MnA Required: True -Position: 0 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingUser.md new file mode 100644 index 000000000..554b984ae --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantIdentityMappingUser.md @@ -0,0 +1,139 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Add-SPOTenantIdentityMappingUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Add-SPOTenantIdentityMappingUser [-SourceTenantCompanyId] [-SourceUserKey] + [[-TargetUserPuid] ] [-TargetUserUpn] [-TargetUserEmail] + [-UserType] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SourceTenantCompanyId +{{ Fill SourceTenantCompanyId Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceUserKey +{{ Fill SourceUserKey Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUserEmail +{{ Fill TargetUserEmail Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUserPuid +{{ Fill TargetUserPuid Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUserUpn +{{ Fill TargetUserUpn Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserType +{{ Fill UserType Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.TenantIdentityMappingUserType +Parameter Sets: (All) +Aliases: +Accepted values: None, RegularUser, AdminUser, GuestUser + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantRestrictedSearchAllowedList.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantRestrictedSearchAllowedList.md new file mode 100644 index 000000000..0bef16abb --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTenantRestrictedSearchAllowedList.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Add-SPOTenantRestrictedSearchAllowedList + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### SitesList +``` +Add-SPOTenantRestrictedSearchAllowedList -SitesList + [] +``` + +### SitesListFileUrl +``` +Add-SPOTenantRestrictedSearchAllowedList -SitesListFileUrl [-ContainsHeader ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContainsHeader +{{ Fill ContainsHeader Description }} + +```yaml +Type: System.Boolean +Parameter Sets: SitesListFileUrl +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SitesList +{{ Fill SitesList Description }} + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: SitesList +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SitesListFileUrl +{{ Fill SitesListFileUrl Description }} + +```yaml +Type: System.String +Parameter Sets: SitesListFileUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTheme.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTheme.md index 4e01ce9f8..8d1cb0705 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOTheme.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spotheme applicable: SharePoint Online @@ -18,8 +18,9 @@ Creates a new custom theme, or overwrites an existing theme to modify its settin ## SYNTAX -```powershell -Add-SPOTheme -Identity -IsInverted -Overwrite -Palette [] +``` +Add-SPOTheme [-Identity] -Palette -IsInverted + [-Overwrite] [] ``` ## DESCRIPTION @@ -81,26 +82,26 @@ Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false - ### -Identity -Specifies the name of the theme. This must uniquely identify the theme. +Specifies the name of the theme. This must uniquely identify the theme. ```yaml -Type: SpoThemePalettePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind Parameter Sets: (All) Aliases: Name Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -IsInverted -Specifies whether the theme is inverted, with a dark background and a light foreground. +Specifies whether the theme is inverted, with a dark background and a light foreground. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: None Applicable: SharePoint Online @@ -116,7 +117,7 @@ Accept wildcard characters: False Overwrites a theme of the same name in case it exists. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: None Applicable: SharePoint Online @@ -129,12 +130,12 @@ Accept wildcard characters: False ### -Palette -Specifies the palette of colors in the theme, as a dictionary of theme slot values. +Specifies the palette of colors in the theme, as a dictionary of theme slot values. ```yaml -Type: SpoThemePalettePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePalettePipeBind Parameter Sets: (All) -Aliases: None +Aliases: Applicable: SharePoint Online Required: True Position: Named @@ -143,6 +144,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind + ## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md index 60958f228..d3948d802 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Add-SPOUser.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/add-spouser applicable: SharePoint Online @@ -18,19 +18,19 @@ Adds an existing Office 365 user or an Office 365 security group to a SharePoint ## SYNTAX -```powershell -Add-SPOUser -Group -LoginName -Site [] +``` +Add-SPOUser -Site -LoginName -Group [] ``` ## DESCRIPTION Along with the group memberships that are normally required to run Windows PowerShell, you must have the SharePoint Admin role and be a site collection administrator to use the `Add-SPOUser` cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Add-SPOUser -Site https://contoso.sharepoint.com/sites/sc1 -LoginName joe.healy@contoso.com -Group "SC1 Owners" @@ -38,7 +38,7 @@ Add-SPOUser -Site https://contoso.sharepoint.com/sites/sc1 -LoginName joe.healy@ Example 1 adds a user who has the e-mail address joe.healy@contoso.com to the group "SC1 Owners" in the site collection -### ------------ Example 2 -------------------- +### Example 2 ```powershell Add-SPOUser -Site https://contoso.sharepoint.com -LoginName melissa.kerr@contoso.com -Group "Team Site Members" @@ -53,7 +53,7 @@ Example 2 adds a user who has the e-mail address melissa.kerr@contoso.com to the Specifies the name of the SharePoint group to add the user or the security group to. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -70,7 +70,7 @@ Accept wildcard characters: False Specifies the login name of the user to add. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -87,7 +87,7 @@ Accept wildcard characters: False Specifies the URL of the site collection to which you want to add the user. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -111,7 +111,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - [Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) + [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [New-SPOSiteGroup](New-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Apply-SPOFontPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Apply-SPOFontPackage.md new file mode 100644 index 000000000..d9214e12e --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Apply-SPOFontPackage.md @@ -0,0 +1,76 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Apply-SPOFontPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Apply-SPOFontPackage [-Identity] [-WebUrl] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebUrl +{{ Fill WebUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md similarity index 51% rename from sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md index 5079b9332..1823f167c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionGrant.md @@ -1,5 +1,5 @@ --- -external help file: +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/approve-spotenantserviceprincipalpermissiongrant applicable: SharePoint Online @@ -18,10 +18,9 @@ Approves a permission request for the current tenant's "SharePoint Online Client ## SYNTAX -### Default - -```powershell -Approve-SPOTenantServicePrincipalPermissionGrant -Resource -Scope +``` +Approve-SPOTenantServicePrincipalPermissionGrant [-Resource] [-Scope] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -30,14 +29,15 @@ Adds a permission for the current tenant's "SharePoint Online Client" service pr ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell - Approve-SPOTenantServicePrincipalPermissionGrant -Resource "Microsoft Graph" -Scope "Mail.Read" +Approve-SPOTenantServicePrincipalPermissionGrant -Resource "Microsoft Graph" -Scope "Mail.Read" ``` Adds a permission scope for the 'Microsoft Graph' resource with scope claim 'Mail.Read'. + ## PARAMETERS ### -Resource @@ -45,13 +45,13 @@ Adds a permission scope for the 'Microsoft Graph' resource with scope claim 'Mai Resource of the permission request to add. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -62,14 +62,60 @@ Accept wildcard characters: False Scope of the permission request to add. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionRequest.md similarity index 53% rename from sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionRequest.md index 70ac81a0d..93c109499 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Approve-SPOTenantServicePrincipalPermissionRequest.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/approve-spotenantserviceprincipalpermissionrequest applicable: SharePoint Online @@ -18,25 +18,23 @@ Approves a permission request for the current tenant's "SharePoint Online Client ## SYNTAX -### Default - -```powershell -Approve-SPOTenantServicePrincipalPermissionRequest -RequestId +``` +Approve-SPOTenantServicePrincipalPermissionRequest -RequestId [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION Approves a permission request for the current tenant's "SharePoint Online Client" service principal -The return value of a successful call is a permission grant object. See the [Description section of Get-SPOTenantServicePrincipalPermissionGrants](https://learn.microsoft.com/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissiongrants#description) for more information about a permission grant object. +The return value of a successful call is a permission grant object. See the [Description section of Get-SPOTenantServicePrincipalPermissionGrants](/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissiongrants#description) for more information about a permission grant object. -To get the collection of permission grants for the "SharePoint Online Client" service principal, use the [Get-SPOTenantServicePrincipalPermissionGrants](https://learn.microsoft.com/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissiongrants) command. +To get the collection of permission grants for the "SharePoint Online Client" service principal, use the [Get-SPOTenantServicePrincipalPermissionGrants](/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissiongrants) command. Approving a permission request also removes that request from the list of permission requests. ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $requests = Get-SPOTenantServicePrincipalPermissionRequests @@ -58,9 +56,59 @@ If there is no request with those properties, then no approve action will be tak The ID of the permission request to approve ```yaml -Type: Guid +Type: System.Guid +Parameter Sets: (All) +Aliases: Required: True Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None Accept pipeline input: False +Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Clear-SPOTenantPreAuthSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Clear-SPOTenantPreAuthSettings.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Clear-SPOTenantPreAuthSettings.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Clear-SPOTenantPreAuthSettings.md index a4c2f533c..5b54d354d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Clear-SPOTenantPreAuthSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Clear-SPOTenantPreAuthSettings.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/clear-spotenantpreauthsettings applicable: SharePoint Online @@ -15,11 +15,11 @@ manager: bhaveshd ## SYNOPSIS -Clears the pre-authentication settings for either the allow or deny list. +Clears the pre-authentication settings for either the allow or deny list. ## SYNTAX -```powershell +``` Clear-SPOTenantPreAuthSettings -Type [-WhatIf] [-Confirm] [] ``` @@ -29,7 +29,7 @@ Clears the pre-authentication settings for either the allow or deny list. > [!NOTE] > **What is pre-authentication?** -> +> > SharePoint includes self-issued tokens in URLs called pre-authentication URLs (also known as tempauth URLs) to provide temporary access to a SharePoint resource, which helps support more rich user experiences. For example, a common scenario is downloading a file using a URL that includes a token in the `tempauth` query parameter like the following: > > `https://.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=&tempauth=v1.ey...` @@ -48,39 +48,39 @@ This example clears all list items from the allow list. ### Example 2 ```powershell -Clear-SPOTenantPreAuthSettings –Type Deny +Clear-SPOTenantPreAuthSettings –Type Deny ``` -This example clears all list items from the deny list. +This example clears all list items from the deny list. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Type + +This parameter indicates whether the cmdlet is interacting with the allow list or the deny list. ```yaml -Type: SwitchParameter +Type: Microsoft.Online.SharePoint.PowerShell.TenantPreAuthSettingsListType Parameter Sets: (All) -Aliases: cf +Aliases: +Accepted values: Allow, Deny -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type - -This parameter indicates whether the cmdlet is interacting with the allow list or the deny list. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: TenantPreAuthSettingsListType +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Accepted values: Allow, Deny +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -92,7 +92,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -104,7 +104,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-5.1). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -118,5 +118,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -- [Get-SPOTenantPreAuthSettings](Get-SPOTenantPreAuthSettings.md) -- [Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md) +[Get-SPOTenantPreAuthSettings](Get-SPOTenantPreAuthSettings.md) + +[Set-SPOTenantPreAuthSettings](Set-SPOTenantPreAuthSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md index d291c6e16..4eecc9c17 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Connect-SPOService.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/connect-sposervice applicable: SharePoint Online @@ -19,19 +19,17 @@ This cmdlet must be run before any other SharePoint Online cmdlets can run. ## SYNTAX -### AuthenticationUrl +### AuthenticationLocation ``` -Connect-SPOService [-Url] [[-Credential] ] - [[-ClientTag] ] [-AuthenticationUrl] [[-ModernAuth] ] - [[-UseSystemBrowser] ] [] +Connect-SPOService -Url [-Credential ] [-ClientTag ] + [-Region ] [-ModernAuth ] [-UseSystemBrowser ] + [] ``` -### AuthenticationLocation - +### AuthenticationUrl ``` -Connect-SPOService [-Url] [[-Credential] ] - [[-ClientTag] ] [[-Region] ] [[-ModernAuth] ] - [[-UseSystemBrowser] ] [] +Connect-SPOService -Url [-Credential ] [-ClientTag ] + -AuthenticationUrl [-ModernAuth ] [-UseSystemBrowser ] [] ``` ## DESCRIPTION @@ -47,11 +45,11 @@ A delegated partner administrator has to swap connections for different organiza You must be a SharePoint Online Administrator or a SharePoint Embedded Administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Connect-SPOService -Url https://contoso-admin.sharepoint.com -credential admin@contoso.com @@ -59,7 +57,7 @@ Connect-SPOService -Url https://contoso-admin.sharepoint.com -credential admin@c Example 1 shows how a SharePoint Online administrator with credential admin@contoso.com connects to a SharePoint Online Administration Center that has the URL `` -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell $username = "admin@contoso.sharepoint.com" @@ -70,7 +68,7 @@ Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential $cred Example 2 shows how a SharePoint Online administrator with a username and password connects to a SharePoint Online Administration Center that has the URL `` -### --------------------`---EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Connect-SPOService -Url https://contoso-admin.sharepoint.com @@ -78,7 +76,7 @@ Connect-SPOService -Url https://contoso-admin.sharepoint.com Prompts for credentials. This is required if the account is using multi-factor authentication. -### -----------------------EXAMPLE 4----------------------------- +### EXAMPLE 4 ```powershell Connect-SPOService -Url https://contoso-admin.sharepoint.com -Region ITAR @@ -86,14 +84,14 @@ Connect-SPOService -Url https://contoso-admin.sharepoint.com -Region ITAR Connects to a SharePoint Online Administration Center specifying the region. -### -----------------------EXAMPLE 5----------------------------- +### EXAMPLE 5 ```powershell Connect-SPOService -Credential $creds -Url https://tenant-admin.sharepoint.com -ModernAuth $true -AuthenticationUrl https://login.microsoftonline.com/organizations ``` Connecting to SPO Service with ModernAuth Flag. -### -----------------------EXAMPLE 6----------------------------- +### EXAMPLE 6 ```powershell Connect-SPOService -Url https://contoso-admin.sharepoint.com -UseSystemBrowser $true @@ -107,7 +105,7 @@ Authenticates using the Microsoft Authentication Library (MSAL) and connects to Location for Microsoft Entra Cross-Tenant Authentication service. Can be optionally used if non-default Cross-Tenant Authentication Service is used. ```yaml -Type: String +Type: System.String Parameter Sets: AuthenticationUrl Aliases: Applicable: SharePoint Online @@ -124,7 +122,7 @@ Accept wildcard characters: False Permits appending a client tag to existing client tag. Used optionally in the CSOM http traffic to identify used script or solution. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -141,7 +139,7 @@ Accept wildcard characters: False 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: CredentialCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -153,6 +151,23 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -ModernAuth + + 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. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -Region The valid values are: Default | ITAR | Germany | China @@ -162,7 +177,7 @@ The default value is "default". **Note**: The ITAR value is for GCC High and DoD tenancies only. ```yaml -Type: AADCrossTenantAuthenticationLocation +Type: Microsoft.Online.SharePoint.PowerShell.AADCrossTenantAuthenticationLocation Parameter Sets: AuthenticationLocation Aliases: Applicable: SharePoint Online @@ -179,7 +194,7 @@ Accept wildcard characters: False Specifies the URL of the SharePoint Online Administration Center site. ```yaml -Type: UrlCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -191,34 +206,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -ModernAuth - - 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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` ### -UseSystemBrowser Used to authenticate the user using the Microsoft Authentication Library (MSAL). ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: 5 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -226,13 +224,18 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS +## NOTES ## RELATED LINKS [Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Disconnect-SPOService](Disconnect-SPOService.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md index 1fa519cbd..241ec316d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationEncryptedPackage.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/convertto-spomigrationencryptedpackage applicable: SharePoint Online @@ -19,17 +19,17 @@ Use this Cmdlet to convert your XML files into a new encrypted migration package ## SYNTAX ### ImplicitSourceParameterSet - -```powershell -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters -MigrationSourceLocations [-NoLogFile] -TargetFilesPath -TargetPackagePath [] +``` +ConvertTo-SPOMigrationEncryptedPackage -MigrationSourceLocations + -EncryptionParameters -TargetFilesPath -TargetPackagePath + [-NoLogFile] [] ``` ### ExplicitSourceParameterSet - -```powershell -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters [-NoLogFile] - -SourceFilesPath -SourcePackagePath -TargetFilesPath -TargetPackagePath - [] +``` +ConvertTo-SPOMigrationEncryptedPackage -SourceFilesPath -SourcePackagePath + -EncryptionParameters -TargetFilesPath -TargetPackagePath + [-NoLogFile] [] ``` ## DESCRIPTION @@ -62,7 +62,7 @@ Parameters of the encryption, it doesn't accept wildcard characters. It accepts parameters like SHA384, SHA256, etc. ```yaml -Type: EncryptionParameters +Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -79,7 +79,7 @@ Accept wildcard characters: False Possible Source locations to migrate ```yaml -Type: MigrationPackageLocation +Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceParameterSet Aliases: Applicable: SharePoint Online @@ -96,7 +96,7 @@ Accept wildcard characters: False Switch Parameter to determine if you should get or not a log file. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -113,7 +113,7 @@ Accept wildcard characters: False Defines the temporary Path where are located the XML source files. ```yaml -Type: String +Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: Applicable: SharePoint Online @@ -130,7 +130,7 @@ Accept wildcard characters: False Defines the source package path location. ```yaml -Type: String +Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: Applicable: SharePoint Online @@ -147,7 +147,7 @@ Accept wildcard characters: False Defines the temporary Path where are located the XML source files. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -164,7 +164,7 @@ Accept wildcard characters: False Defines the source package path location of the package to be encrypted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -180,11 +180,21 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) [ConvertTo-SPOMigrationTargetedPackage](ConvertTo-SPOMigrationTargetedPackage.md) -[Migrate to SharePoint Online using PowerShell](https://learn.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets) +[Migrate to SharePoint Online using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md index 41de90700..a5ab91ed5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/ConvertTo-SPOMigrationTargetedPackage.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/convertto-spomigrationtargetedpackage applicable: SharePoint Online @@ -19,15 +19,22 @@ Use this cmdlet to convert your XML files into a new migration package. ## SYNTAX ### DocumentLibraryImport - -```powershell -ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] [-SourcePackagePath] [[-OutputPackagePath] ] [-TargetWebUrl] [-AzureADUserCredentials ] -Credentials [-NoAzureADLookup] [-NoLogFile] [-ParallelImport] [-PartitionSizeInBytes ] -TargetDocumentLibraryPath [-TargetDocumentLibrarySubFolderPath ] [-TargetEnvironment ] [-UserMappingFile ] [] +``` +ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] [-SourcePackagePath] + [[-OutputPackagePath] ] [-TargetWebUrl] -TargetDocumentLibraryPath + [-TargetDocumentLibrarySubFolderPath ] [-UserMappingFile ] + -Credentials [-AzureADUserCredentials ] + [-NoAzureADLookup] [-TargetEnvironment ] [-ParallelImport] [-PartitionSizeInBytes ] + [-NoLogFile] [] ``` ### ListImport - -```powershell -ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] [-SourcePackagePath] [[-OutputPackagePath] ] [-TargetWebUrl] [-AzureADUserCredentials ] -Credentials [-NoAzureADLookup] [-NoLogFile] [-ParallelImport] [-PartitionSizeInBytes ] [-TargetEnvironment ] -TargetListPath [-UserMappingFile ] [] +``` +ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] [-SourcePackagePath] + [[-OutputPackagePath] ] [-TargetWebUrl] -TargetListPath [-UserMappingFile ] + -Credentials [-AzureADUserCredentials ] + [-NoAzureADLookup] [-TargetEnvironment ] [-ParallelImport] [-PartitionSizeInBytes ] + [-NoLogFile] [] ``` ## DESCRIPTION @@ -49,7 +56,7 @@ $finalPackages = ConvertTo-SPOMigrationTargetedPackage -ParallelImport -SourceFi Receives Microsoft Entra User Credentials ```yaml -Type: CredentialCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -66,7 +73,7 @@ Accept wildcard characters: False Fill out the Regular Credentials (Get-Credential) ```yaml -Type: CredentialCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -83,7 +90,7 @@ Accept wildcard characters: False Switch parameter that says if the command should or should not look up for Microsoft Entra ID. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -100,7 +107,7 @@ Accept wildcard characters: False Switch Parameter to determine if you should get or not a log file. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -117,7 +124,7 @@ Accept wildcard characters: False Output package path ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -134,7 +141,7 @@ Accept wildcard characters: False Switch parameter to boost file share migration performance. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -151,7 +158,7 @@ Accept wildcard characters: False Define the partition size in Bytes where it will be located the target package. ```yaml -Type: Int64 +Type: System.Int64 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -168,7 +175,7 @@ Accept wildcard characters: False Defines the temporary Path where are located the XML source files. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -185,7 +192,7 @@ Accept wildcard characters: False Defines the source package path location. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -202,7 +209,7 @@ Accept wildcard characters: False Defines the target document library path. ```yaml -Type: String +Type: System.String Parameter Sets: DocumentLibraryImport Aliases: Applicable: SharePoint Online @@ -219,7 +226,7 @@ Accept wildcard characters: False Defines the target document library subfolder path. ```yaml -Type: String +Type: System.String Parameter Sets: DocumentLibraryImport Aliases: Applicable: SharePoint Online @@ -236,7 +243,7 @@ Accept wildcard characters: False Defines the Target environment: Production, ProductionChina, None or OnPremises. ```yaml -Type: TargetEnvironment +Type: Microsoft.Online.SharePoint.Migration.TargetEnvironment Parameter Sets: (All) Aliases: Accepted values: Production, ProductionChina, None, OnPremises @@ -254,7 +261,7 @@ Accept wildcard characters: False Defines the Target list path ```yaml -Type: String +Type: System.String Parameter Sets: ListImport Aliases: Applicable: SharePoint Online @@ -271,7 +278,7 @@ Accept wildcard characters: False Defines the Target Web URL of the package. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -288,7 +295,7 @@ Accept wildcard characters: False Defines the file mapping of the user. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -304,9 +311,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Copy-SPOPersonalSitePage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Copy-SPOPersonalSitePage.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md index 1e8d5bd04..2a94781a2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Copy-SPOPersonalSitePage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Copy-SPOPersonalSitePage.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/copy-spopersonalsitepage applicable: SharePoint Online @@ -20,8 +20,9 @@ This cmdlet command allows you to relocate existing SharePoint pages by utilizin ## SYNTAX -```powershell -Copy-SPOPersonalSitePage -SourceSite -DestinationSite -PageName -DeleteSourcePage [-Confirm] [] +``` +Copy-SPOPersonalSitePage -SourceSite -DestinationSite -PageName + [-DeleteSourcePage] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,10 +35,10 @@ The Copy-SPOPersonalSitePage cmdlet allows a SharePoint Administrator to copy on **Where can I move the existing page(s) to and from?** | Source | Destination | -| :------------------- | :---------- | -| SharePoint pages library in OneDrive for Business | SharePoint pages library in OneDrive for Business | -| SharePoint pages library in OneDrive for Business | SharePoint site | -| SharePoint site | SharePoint site | +| :------------------- | :---------- | +| SharePoint pages library in OneDrive for Business | SharePoint pages library in OneDrive for Business | +| SharePoint pages library in OneDrive for Business | SharePoint site | +| SharePoint site | SharePoint site | **How do I query the status of my copy operation?** @@ -58,7 +59,7 @@ After this cmdlet is executed, you'll receive the following information: The following table explains the copy job's state: | Status | Explanation | -| :---------- | :---------- | +| :---------- | :---------- | | Queued | The copy operation was queued for execution. | | CreateAssetsFolderStart | We've started creating a folder to place all associated assets used on this page. | | CreateAssetsFolderEnd | We've finished creating a folder to place all associated assets used on this page. | @@ -73,15 +74,15 @@ The following table explains the copy job's state: ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell -Copy-SPOPersonalSitePage -SourceSite 'https://contoso-my.sharepoint.com/personal/testuser_onmicrosoft_com' -DestinationSite 'https://contoso.sharepoint.com/sites/testsite' -PageName 'TestPage.aspx' -Confirm +Copy-SPOPersonalSitePage -SourceSite 'https://contoso-my.sharepoint.com/personal/testuser_onmicrosoft_com' -DestinationSite 'https://contoso.sharepoint.com/sites/testsite' -PageName 'TestPage.aspx' -Confirm ``` Example 1 demonstrates how a SharePoint Administrator can copy the SharePoint page named `TestPage.aspx` from `testuser`'s SharePoint pages library in OneDrive for Business to the `testsite` SharePoint site with confirmation. The source page will not be deleted. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Copy-SPOPersonalSitePage -SourceSite 'https://contoso-my.sharepoint.com/personal/testuser_onmicrosoft_com' -DestinationSite 'https://contoso.sharepoint.com/sites/testsite' -PageName 'TestPage.aspx' -DeleteSourcePage @@ -89,7 +90,7 @@ Copy-SPOPersonalSitePage -SourceSite 'https://contoso-my.sharepoint.com/personal Example 2 demonstrates how a SharePoint Administrator can move the SharePoint page named `TestPage.aspx` from `testuser`'s SharePoint pages library in OneDrive for Business to the `testsite` SharePoint site. The source page will be deleted after the copy operation. -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Copy-SPOPersonalSitePage -SourceSite 'https://contoso.sharepoint.com/sites/sourcesite' -DestinationSite 'https://contoso.sharepoint.com/sites/testsite' -PageName 'TestPage.aspx' -DeleteSourcePage -Confirm @@ -97,7 +98,7 @@ Copy-SPOPersonalSitePage -SourceSite 'https://contoso.sharepoint.com/sites/sourc Example 3 demonstrates how a SharePoint Administrator can copy the SharePoint page named `TestPage.aspx` from a SharePoint site name `sourcesite` to the `testsite` SharePoint site with confirmation. The source page will be deleted after the copy operation. -### -----------------------EXAMPLE 4----------------------------- +### EXAMPLE 4 ```powershell Copy-SPOPersonalSitePage -SourceSite 'https://contoso-my.sharepoint.com/personal/testuser1_onmicrosoft_com' -DestinationSite 'https://contoso-my.sharepoint.com/personal/testuser2_onmicrosoft_com' -PageName 'TestPage.aspx' -DeleteSourcePage -Confirm @@ -107,17 +108,17 @@ Example 4 demonstrates how a SharePoint Administrator can move the SharePoint pa ## PARAMETERS -### -SourceSite +### -DeleteSourcePage -Specifies the URL of the source SharePoint site containing the SharePoint pages to copy. +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: SpoSitePipeBind +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -129,7 +130,7 @@ Accept wildcard characters: False Specifies the URL of the destination SharePoint site where the SharePoint pages will be copied to. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -137,7 +138,7 @@ Applicable: SharePoint Online Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -146,7 +147,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -158,12 +159,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DeleteSourcePage +### -SourceSite -Indicates whether to delete the source SharePoint page(s) after copying. If specified, the operation will move the SharePoint page(s) instead of copying. +Specifies the URL of the source SharePoint site containing the SharePoint pages to copy. ```yaml -Type: SwitchParameter +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -171,20 +172,33 @@ Applicable: SharePoint Online Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Confirm - -Prompts for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -194,10 +208,17 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +### System.Object -## Notes +## NOTES **Question: Will SharePoint pages retain their version history after the move?** diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Deny-SPOTenantServicePrincipalPermissionRequest.md similarity index 54% rename from sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Deny-SPOTenantServicePrincipalPermissionRequest.md index 937b18e3d..33986bc53 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Deny-SPOTenantServicePrincipalPermissionRequest.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/deny-spotenantserviceprincipalpermissionrequest applicable: SharePoint Online @@ -18,10 +18,8 @@ Denies a permission request for the current tenant's "SharePoint Online Client" ## SYNTAX -### Default - -```powershell -Deny-SPOTenantServicePrincipalPermissionRequest -RequestId +``` +Deny-SPOTenantServicePrincipalPermissionRequest -RequestId [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,7 +30,7 @@ Denying a permission request removes that request from the list of permission re ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $requests = Get-SPOTenantServicePrincipalPermissionRequests @@ -54,9 +52,59 @@ If there is no request with those properties, then no deny action will be taken. The ID of the permission request to deny ```yaml -Type: Guid +Type: System.Guid +Parameter Sets: (All) +Aliases: Required: True Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None Accept pipeline input: False +Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Disable-SPOTenantServicePrincipal.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Disable-SPOTenantServicePrincipal.md new file mode 100644 index 000000000..f86a29421 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Disable-SPOTenantServicePrincipal.md @@ -0,0 +1,88 @@ +--- +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/disable-spotenantserviceprincipal +applicable: SharePoint Online +title: Disable-SPOTenantServicePrincipal +schema: 2.0.0 +author: trent-green +ms.author: trgreen +ms.reviewer: +--- + +# Disable-SPOTenantServicePrincipal + +## SYNOPSIS + +Disables the current tenant's "SharePoint Online Client" service principal. + +## SYNTAX + +``` +Disable-SPOTenantServicePrincipal [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Disables the current tenant's "SharePoint Online Client" service principal. + +When the service principal's account is disabled, clients and components that use this service principal +will not be able to request an access token for this service principal. + +## EXAMPLES + +### Example 1 + +```powershell +Disable-SPOTenantServicePrincipal +``` + +Disables the current tenant's "SharePoint Online Client" service principal. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Disconnect-SPOService.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Disconnect-SPOService.md index 283db3332..70e2995bc 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Disconnect-SPOService.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/disconnect-sposervice applicable: SharePoint Online @@ -18,7 +18,7 @@ Disconnects from a SharePoint Online service. ## SYNTAX -```powershell +``` Disconnect-SPOService [] ``` @@ -34,11 +34,11 @@ In other words, long-running operations will not be terminated by running the `D You must be a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Disconnect-SPOService @@ -60,7 +60,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOCommSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOCommSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md index 2d1404112..6283004fe 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOCommSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOCommSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/enable-spocommsite applicable: SharePoint Online @@ -14,12 +14,12 @@ ms.reviewer: ## SYNOPSIS -Enables the communication site experience on an existing classic team site. Please read instructions in [modernize classic team site](https://learn.microsoft.com/sharepoint/modernize-classic-team-site) before attempting to execute this cmdlet. +Enables the communication site experience on an existing classic team site. Please read instructions in [modernize classic team site](/sharepoint/modernize-classic-team-site) before attempting to execute this cmdlet. ## SYNTAX -```powershell -Enable-SPOCommSite [-SiteUrl] [-DesignPackageId] +``` +Enable-SPOCommSite -SiteUrl [-DesignPackageId ] [] ``` ## DESCRIPTION @@ -67,52 +67,52 @@ If the site URL input points to a site that does not exist, you will see the fol **Error case 4: Classic publishing feature is currently enabled** -We do not support sites that currently have or have had in the past enabled the classic publishing features. If you see this error, your site is not eligible for this feature enablement. Please check [requirements for this feature](https://learn.microsoft.com/sharepoint/modernize-classic-team-site). +We do not support sites that currently have or have had in the past enabled the classic publishing features. If you see this error, your site is not eligible for this feature enablement. Please check [requirements for this feature](/sharepoint/modernize-classic-team-site). >*Enable-SPOCommSite : The operation cannot be performed because the Publishing feature is enabled on the site.* ## PARAMETERS -### -SiteUrl +### -DesignPackageId -URL of the site for enabling the modern communication site experience. **This is a required parameter** +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 +2. Showcase: 6142d2a0-63a5-4ba0-aede-d9fefca2c767 +3. Blank: f6cc5403-0d63-442e-96c0-285923709ffc ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online - -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DesignPackageId - -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: +### -SiteUrl -1. Topic: 96c933ac-3698-44c7-9f4a-5fd17d71af9e -2. Showcase: 6142d2a0-63a5-4ba0-aede-d9fefca2c767 -3. Blank: f6cc5403-0d63-442e-96c0-285923709ffc +URL of the site for enabling the modern communication site experience. **This is a required parameter** ```yaml -Type: GUID +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False + +Required: True Position: Named -Default value: 96c933ac-3698-44c7-9f4a-5fd17d71af9e +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOTenantServicePrincipal.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOTenantServicePrincipal.md index ad0c57fb7..9e4878f14 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Enable-SPOTenantServicePrincipal.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/enable-spotenantserviceprincipal applicable: SharePoint Online @@ -18,7 +18,7 @@ Enables the current tenant's "SharePoint Online Client" service principal. ## SYNTAX -```powershell +``` Enable-SPOTenantServicePrincipal [-WhatIf] [-Confirm] [] ``` @@ -28,7 +28,7 @@ Enables the current tenant's "SharePoint Online Client" service principal. ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Enable-SPOTenantServicePrincipal @@ -43,7 +43,7 @@ Enables the current tenant's "SharePoint Online Client" service principal. Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -60,7 +60,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -73,7 +73,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPODataAccessGovernanceInsight.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPODataAccessGovernanceInsight.md similarity index 89% rename from sharepoint/sharepoint-ps/sharepoint-online/Export-SPODataAccessGovernanceInsight.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPODataAccessGovernanceInsight.md index 099792f96..a55bd1d1b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPODataAccessGovernanceInsight.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPODataAccessGovernanceInsight.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/export-spodataaccessgovernanceinsight applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Export-SPODataAccessGovernanceInsight schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -20,7 +20,7 @@ This cmdlet downloads the Data Access Governance (DAG) reports to the specified ## SYNTAX ``` -Export-SPODataAccessGovernanceInsight -ReportID [] +Export-SPODataAccessGovernanceInsight -ReportID [-DownloadPath ] [] ``` ## DESCRIPTION @@ -39,32 +39,32 @@ The above example downloads the report of the given ID to the current working di ## PARAMETERS -### -ReportID +### -DownloadPath -Specifies the ID of the DAG report to be downloaded. +Specifies the path to which the report should be downloaded. The default path is the "Downloads" folder. ```yaml -Type: Guid +Type: System.String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DownloadPath +### -ReportID -Specifies the path to which the report should be downloaded. The default path is the "Downloads" folder. +Specifies the ID of the DAG report to be downloaded. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -73,7 +73,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md index f4179b2e7..22afd580a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOQueryLogs.md @@ -22,7 +22,7 @@ Export query logs for a user in an Office 365 tenant. ## SYNTAX -```powershell +``` Export-SPOQueryLogs [-StartTime ] -LoginName -OutputFolder [] ``` @@ -39,11 +39,11 @@ The output of the queries.csv will be for example: You have to be a tenant admin to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Export-SPOQueryLogs -LoginName user1@contoso.sharepoint.com @@ -51,7 +51,7 @@ Export-SPOQueryLogs -LoginName user1@contoso.sharepoint.com Example 1 exports the query log for a user who has the e-mail address user1@contoso.sharepoint.com to the two files user1@contoso.sharepoint.com_queries.csv and user1@contoso.sharepoint.com_personalQueries.csv, in the current working folder. -### ------------ Example 2 -------------------- +### Example 2 ```powershell Export-SPOQueryLogs -LoginName user1@contoso.sharepoint.com -StartTime "2018-10-21" -OutputFolder "c:\users\contosoadmin\Documents" @@ -66,7 +66,7 @@ Example 2 exports the query log from the starting time 21. October 2018, for a u Specifies the login name of the user to export. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -83,7 +83,7 @@ Accept wildcard characters: False Target folder where the CSV file is generated. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -100,7 +100,7 @@ Accept wildcard characters: False Specifies from which point of time to export the logs from. Use the date format YYYY-MM-DD. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -129,6 +129,6 @@ For more information, see [about_CommonParameters](https://go.microsoft.com/fwli ## RELATED LINKS -[Introduction to the SharePoint Online management shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps) +[Introduction to the SharePoint Online management shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell) -[Set up the SharePoint Online Management Shell Windows PowerShell environment](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Set up the SharePoint Online Management Shell Windows PowerShell environment](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByPartner.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOSites.md similarity index 52% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByPartner.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOSites.md index be69e00dc..5c5f1acf4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByPartner.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOSites.md @@ -1,70 +1,57 @@ --- -external help file: sharepointonline.xml +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/Get-SPOTenantOrgRelationByPartner -applicable: SharePoint Online -title: Get-SPOTenantOrgRelationByPartner +online version: schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: --- - -# Get-SPOTenantOrgRelationByPartner +# Export-SPOSites ## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. +{{ Fill in the Synopsis }} ## SYNTAX -```powershell -Get-SPOTenantOrgRelationByPartner [-PartnerCompanyId] [[-PartnerInstanceId] ] [] +``` +Export-SPOSites [[-DownloadLocation] ] [[-TimeZoneId] ] [] ``` ## DESCRIPTION - {{ Fill in the Description }} ## EXAMPLES ### Example 1 - ```powershell - +PS C:\> {{ Add example code here }} ``` {{ Add example description here }} ## PARAMETERS -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} +### -DownloadLocation +{{ Fill DownloadLocation Description }} ```yaml -Type: Guid +Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online -Required: True +Required: False Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PartnerInstanceId - -{{ Fill PartnerInstanceId Description }} +### -TimeZoneId +{{ Fill TimeZoneId Description }} ```yaml -Type: Guid +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online Required: False Position: 1 @@ -74,8 +61,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md index 74398e37f..4dd3120ae 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserInfo.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/export-spouserinfo applicable: SharePoint Online @@ -18,19 +18,19 @@ Export user information from site user information list. ## SYNTAX -```powershell -Export-SPOUserInfo -LoginName -Site -OutputFolder [] +``` +Export-SPOUserInfo -LoginName -Site [-OutputFolder ] [] ``` ## DESCRIPTION Export user information from site user information list. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Export-SPOUserInfo -LoginName joe.healy@contoso.com -site https://contoso.sharepoint.com/sites/sc1 -OutputFolder "C:\users\admin\exportfolder" @@ -38,7 +38,7 @@ Export-SPOUserInfo -LoginName joe.healy@contoso.com -site https://contoso.sharep Example 1 exports a user data who has the e-mail address joe.healy@contoso.com from the site collection to folder C:\users\admin\exportfolder. -### ------------ Example 2 -------------------- +### Example 2 ```powershell $sites = Get-SPOSite -IncludePersonalSite $true @@ -59,7 +59,7 @@ Example 2 exports user data who has email address joe.healy@contoso.com from all Specifies the login name of the user to export. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -71,29 +71,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Site +### -OutputFolder -Specifies the URL of the site collection to which you want to export the user. +Target folder where the CSV file is generated. ```yaml -Type: SpoSitePipeBind +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutputFolder +### -Site -Target folder where the CSV file is generated. +Specifies the URL of the site collection to which you want to export the user. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -111,13 +111,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [New-SPOSiteGroup](New-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md index 52d4dece2..282fbbf6c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Export-SPOUserProfile.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/export-spouserprofile applicable: SharePoint Online @@ -18,19 +18,19 @@ Export user profile data to csv file. ## SYNTAX -```powershell -Export-SPOUserProfile -LoginName -OutputFolder [] +``` +Export-SPOUserProfile -LoginName [-OutputFolder ] [] ``` ## DESCRIPTION Export user profile data to csv file. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Export-SPOUserProfile -LoginName joe.healy@contoso.com -OutputFolder "C:\users\admin\exportfolder" @@ -45,7 +45,7 @@ Example 1 exports user data who has the e-mail address joe.healy@contoso.com to Specifies the login name of the user whose data is exported. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -62,12 +62,12 @@ Accept wildcard characters: False Specifies the output folder location where the CSV file is created. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -80,8 +80,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-FileSensitivityLabelInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-FileSensitivityLabelInfo.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md index 54b824840..b11b3319a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-FileSensitivityLabelInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-FileSensitivityLabelInfo.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Get-FileSensitivityLabelInfo applicable: SharePoint Online @@ -18,8 +18,8 @@ Extracts and displays the sensitivity label related information attached to an o ## SYNTAX -```powershell -Get-FileSensitivityLabelInfo -FileUrl [] +``` +Get-FileSensitivityLabelInfo [-FileUrl] [] ``` ## DESCRIPTION @@ -42,20 +42,29 @@ For permissions and the most current information about Windows PowerShell for Sh Full URL for the file. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None +Accept pipeline input: False +Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppBillingPolicies.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppBillingPolicies.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppBillingPolicies.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppBillingPolicies.md index ffe93be03..fdbc937da 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppBillingPolicies.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppBillingPolicies.md @@ -1,53 +1,70 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Get-SPOAppBillingPolicies -applicable: SharePoint Online -title: Get-SPOAppBillingPolicies -schema: 2.0.0 -author: arakesh -ms.author: arakesh -ms.reviewer: ---- -# Get-SPOAppBillingPolicies - -## SYNOPSIS - -Returns billing policies that are owned by the tenant. - -## SYNTAX - -```powershell -Get-SPOAppBillingPolicies -``` - -## DESCRIPTION - -Get-SPOAppBillingPolicies returns a list of billing policies that are owned by the tenant. If the tenant has no billing policies associated, the cmdlet will produce no output. - -The output of this cmdlet will include information related to the billing policy such as Application Id, Azure subscription ID, Resource Group, Region, State of the subscription and the usage charging model. - -You must be a SharePoint Administrator to run this cmdlet. - -> [!NOTE] -> To use the Get-SPOAppBillingPolicies cmdlet, an admin must authenticate to SharePoint Online using modern authentication. -> -> Use the **Connect-SPOService** cmdlet shown below, which will prompt you to enter your credentials. If multi-factor authentication (MFA) is enabled, you will need to complete the MFA process (e.g., entering a verification code sent to your phone). -> -> `Connect-SPOService -Url https://(your-tenant)-admin.sharepoint.com` -> -> Replace (your-tenant) with your actual SharePoint Online domain, e.g. `https://contoso-admin.sharepoint.com. ` - -## EXAMPLES - -### Example 1 - -```powershell - -Get-SPOAppBillingPolicies - -``` - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +--- +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/Get-SPOAppBillingPolicies +applicable: SharePoint Online +title: Get-SPOAppBillingPolicies +schema: 2.0.0 +author: arakesh +ms.author: arakesh +ms.reviewer: +--- +# Get-SPOAppBillingPolicies + +## SYNOPSIS + +Returns billing policies that are owned by the tenant. + +## SYNTAX + +``` +Get-SPOAppBillingPolicies [] +``` + +## DESCRIPTION + +Get-SPOAppBillingPolicies returns a list of billing policies that are owned by the tenant. If the tenant has no billing policies associated, the cmdlet will produce no output. + +The output of this cmdlet will include information related to the billing policy such as Application Id, Azure subscription ID, Resource Group, Region, State of the subscription and the usage charging model. + +You must be a SharePoint Administrator to run this cmdlet. + +> [!NOTE] +> To use the Get-SPOAppBillingPolicies cmdlet, an admin must authenticate to SharePoint Online using modern authentication. +> +> Use the **Connect-SPOService** cmdlet shown below, which will prompt you to enter your credentials. If multi-factor authentication (MFA) is enabled, you will need to complete the MFA process (e.g., entering a verification code sent to your phone). +> +> `Connect-SPOService -Url https://(your-tenant)-admin.sharepoint.com` +> +> Replace (your-tenant) with your actual SharePoint Online domain, e.g. `https://contoso-admin.sharepoint.com. ` + +## EXAMPLES + +### Example 1 + +```powershell + +Get-SPOAppBillingPolicies + +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md index dfdcb200f..b21ed002d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppErrors.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spoapperrors applicable: SharePoint Online @@ -18,8 +18,8 @@ Returns application errors. ## SYNTAX -```powershell -Get-SPOAppErrors [-EndTimeInUtc ] -ProductId [-StartTimeInUtc ] [] +``` +Get-SPOAppErrors -ProductId [-StartTimeInUtc ] [-EndTimeInUtc ] [] ``` ## DESCRIPTION @@ -36,11 +36,11 @@ Values for error type are as follows: 0 - None, 1 - Install Error, 2 - Upgrade E You must be a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Get-SPOAppErrors -ProductId ba51729b-e017-409d-681a-66f1dd18f0f4 @@ -48,7 +48,7 @@ Get-SPOAppErrors -ProductId ba51729b-e017-409d-681a-66f1dd18f0f4 This example returns a collection of monitoring error message(s) for application whose GUID is ba51729b-e017-409d-681a-66f1dd18f0f4. -### ------------ Example 2 -------------------- +### Example 2 ```powershell Get-SPOAppErrors -ProductId ba51729b-e017-409d-681a-66f1dd18f0f4 -StartTimeInUtc (Get-Date).AddHours(-1).ToUniversalTime() @@ -63,7 +63,7 @@ This example returns a collection of monitoring error message(s) for application 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: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -80,7 +80,7 @@ Accept wildcard characters: False Specifies the application's GUID. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -97,7 +97,7 @@ Accept wildcard characters: False 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: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -121,6 +121,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppInfo](Get-SPOAppInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md index 575b617d2..1e23ce4c4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAppInfo.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spoappinfo applicable: SharePoint Online @@ -18,7 +18,7 @@ Returns all installed applications. ## SYNTAX -```powershell +``` Get-SPOAppInfo [[-ProductId] ] [[-Name] ] [] ``` @@ -32,11 +32,11 @@ The returned collection of installed applications contains Product ID (GUID), Pr You must be a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Get-SPOAppInfo -Name "Excel Service" @@ -44,7 +44,7 @@ Get-SPOAppInfo -Name "Excel Service" Example 1 returns all the installed applications from the external marketplace or from the App Catalog that contain "Excel Service" in their application names. -### ------------ Example 2 -------------------- +### Example 2 ```powershell Get-SPOAppInfo -ProductId 6751729b-e017-409d-681a-66f1dd18f0ff @@ -52,13 +52,13 @@ Get-SPOAppInfo -ProductId 6751729b-e017-409d-681a-66f1dd18f0ff Example 2 returns the installed application that has the GUID 6751729b-e017-409d-681a-66f1dd18f0ff. -### ------------ Example 3 -------------------- +### Example 3 ```powershell Get-SPOAppInfo -Name " " | Sort Name ``` -Example 3 returns all the installed applications that have a space in the name and sorts them in ascending order. +Example 3 returns all the installed applications that have a space in the name and sorts them in ascending order. ## PARAMETERS @@ -67,7 +67,7 @@ Example 3 returns all the installed applications that have a space in the name a Specifies the application's name. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -84,7 +84,7 @@ Accept wildcard characters: False Specifies the application's GUID. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOApplication.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOApplication.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOApplication.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOApplication.md index 4059f96e4..6fa16a6c6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOApplication.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spoapplication applicable: SharePoint @@ -22,23 +22,6 @@ Returns a list of SharePoint Embedded applications in the specified tenant. Get-SPOApplication [[-OwningApplicationId] ] [[-ApplicationId] ] [] ``` -### ParamSet1 - -```powershell -Get-SPOApplication [] -``` -### ParamSet2 - -```powershell -Get-SPOApplication [[-OwningApplicationId] ] [] -``` - -### ParamSet3 - -```powershell -Get-SPOApplication [[-OwningApplicationId] ] [[-ApplicationId] ][] -``` - ## DESCRIPTION This cmdlet is used to retrieve and return SharePoint Embedded applications from all publishers registered within a tenant. This cmdlet can be further customized by pairing it with the `OwningApplicationId` parameter to target a specific application. @@ -84,6 +67,22 @@ Example 4 enumerates the entire list of the host URLs driving the Copilot embedd ## PARAMETERS +### -ApplicationId + +Use this parameter to enumerate app-only permissions of the guest application id with access to the specified owning application. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OwningApplicationId Use this parameter to get details about applications registered in the specified tenant. @@ -103,7 +102,7 @@ The following details are returned: - CopilotEmbeddedChatHosts ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -114,26 +113,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId +### CommonParameters -Use this parameter to enumerate app-only permissions of the guest application id with access to the specified owning application. +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: +## INPUTS -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### None -### CommonParameters +## OUTPUTS -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +### System.Object +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAuditDataCollectionStatusForActivityInsights.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAuditDataCollectionStatusForActivityInsights.md index 8ed73c05c..5fd14c578 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOAuditDataCollectionStatusForActivityInsights.md @@ -1,5 +1,5 @@ ---- -external help file: sharepointonline.xml +--- +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/get-spoauditdatacollectionstatusforactivityinsights applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Get-SPOAuditDataCollectionStatusForActivityInsights schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -45,7 +45,7 @@ This example fetches the current status of audit data collection for the report Specifies the entity for which the corresponding audit data collection status should be shown. ```yaml -Type: OptInReportEntityEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.OptInReportEntityEnum Parameter Sets: (All) Aliases: Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights @@ -58,8 +58,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -74,5 +73,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## RELATED LINKS [Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md) + [Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md) + [Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBlockedPageCreationContentTypeList.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBlockedPageCreationContentTypeList.md new file mode 100644 index 000000000..1cc13e04b --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBlockedPageCreationContentTypeList.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOBlockedPageCreationContentTypeList + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOBlockedPageCreationContentTypeList [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBrowserIdleSignOut.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBrowserIdleSignOut.md similarity index 89% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBrowserIdleSignOut.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBrowserIdleSignOut.md index c7b33f567..1d54cf76a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBrowserIdleSignOut.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBrowserIdleSignOut.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spobrowseridlesignout applicable: SharePoint Online @@ -18,7 +18,7 @@ Used to retrieve the current configuration values for Idle session sign-out poli ## SYNTAX -```powershell +``` Get-SPOBrowserIdleSignOut [] ``` @@ -42,4 +42,14 @@ This example retrieves the current configuration values for Idle session sign-ou This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInDesignPackageVisibility.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInDesignPackageVisibility.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInDesignPackageVisibility.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInDesignPackageVisibility.md index 4c546e052..a050582e3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInDesignPackageVisibility.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInDesignPackageVisibility.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spobuiltindesignpackagevisibility applicable: SharePoint Online @@ -18,7 +18,7 @@ Gets the visibility of the available built-in Design Packages. ## SYNTAX -```powershell +``` Get-SPOBuiltInDesignPackageVisibility [-DesignPackage ] [] ``` @@ -55,10 +55,11 @@ Name of the design package, available names are - TeamSite ```yaml -Type: DesignPackageType +Type: Microsoft.SharePoint.Administration.DesignPackageType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online +Accepted values: None, Topic, Showcase, Blank, TeamSite + Required: False Position: Named Default value: None @@ -67,7 +68,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +### None + +## OUTPUTS + +### System.Object ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInFontPackageSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInFontPackageSettings.md similarity index 55% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInFontPackageSettings.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInFontPackageSettings.md index 94b0ee0c1..804cd5599 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInFontPackageSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInFontPackageSettings.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spobuiltinfontpackagesettings applicable: SharePoint Online @@ -15,11 +15,11 @@ ms.reviewer: ## SYNOPSIS Use this cmdlet to get settings of [built-in font packages](/sharepoint/brand-center-font-packages). - + ## SYNTAX -```powershell -Get-SPOBuiltInFontPackageSettings +``` +Get-SPOBuiltInFontPackageSettings [] ``` ## DESCRIPTION @@ -36,6 +36,21 @@ Get-SPOBuiltInFontPackageSettings This example retrieves the current settings of built-in font packages. +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -- [Set-SPOBuiltInFontPackageSettings](./Set-SPOBuiltInFontPackageSettings.md) \ No newline at end of file +[Set-SPOBuiltInFontPackageSettings](./Set-SPOBuiltInFontPackageSettings.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInSiteTemplateSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInSiteTemplateSettings.md similarity index 60% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInSiteTemplateSettings.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInSiteTemplateSettings.md index b45e3ecf6..cf20c5f6f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInSiteTemplateSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOBuiltInSiteTemplateSettings.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Get-SPOBuiltInSiteTemplateSettings applicable: SharePoint Online @@ -18,40 +18,64 @@ Get the current state of Microsoft-provided SharePoint site templates displayed ## SYNTAX -```powershell -Get-SPOBuiltInSiteTemplateSettings -Identity +``` +Get-SPOBuiltInSiteTemplateSettings [[-Identity] ] [] ``` ## DESCRIPTION -The `Get-SPOBuiltInSiteTemplateSettings` cmdlet displays the current state of Microsoft-provided SharePoint site templates displayed or hidden in the site template gallery in your tenant. +The `Get-SPOBuiltInSiteTemplateSettings` cmdlet displays the current state of Microsoft-provided SharePoint site templates displayed or hidden in the site template gallery in your tenant. >[!NOTE] > - All site templates are displayed by default. [Learn more](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398) about SharePoint site templates > - You must have SharePoint admin credentials (or higher) to use SharePoint PowerShell. > - The minimum SharePoint PowerShell version required is 16.0.21610.12000. -> - For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +> - For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES ### Check which Microsoft templates are hidden -This example checks what Microsoft-provided SharePoint site templates are currently hidden from the site template gallery. +This example checks what Microsoft-provided SharePoint site templates are currently hidden from the site template gallery. ```powershell -Get-SPOBuiltInSiteTemplateSettings +Get-SPOBuiltInSiteTemplateSettings ``` >[!NOTE] -> If a site template has never been hidden, it will not show up in the list. If a site template has been hidden, then changed back to displayed (i.e. currently set to True), then it will show up in the list. +> If a site template has never been hidden, it will not show up in the list. If a site template has been hidden, then changed back to displayed (i.e. currently set to True), then it will show up in the list. ## PARAMETERS ### -Identity - -Specifies the ID for the site template if you'd like to filter results. +Specifies the ID for the site template if you'd like to filter results. + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOBuiltInSiteTemplateSettingsPipeBind +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOBuiltInSiteTemplateSettingsPipeBind + +## OUTPUTS + +### System.Object + +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md similarity index 72% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainer.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md index 23f1f62d5..f04c33671 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocontainer applicable: SharePoint Online @@ -14,30 +14,31 @@ ms.reviewer: ## SYNOPSIS -Returns one or more containers in a SharePoint Embedded application. +Returns one or more containers in a SharePoint Embedded application. ## SYNTAX -### ParamSet1 - -```powershell -Get-SPOContainer -Identity [] +### OwningApplicationId ``` - -### ParamSet2 - -```powershell Get-SPOContainer [-OwningApplicationId] [-Paged] [[-PagingToken] ] [] ``` -### ParamSet3 -```powershell -Get-SPOContainer [-OwningApplicationId] [-Paged] [[-PagingToken] ] [-SortByStorage] [] +### Sort +``` +Get-SPOContainer [-OwningApplicationId] [-Paged] [[-PagingToken] ] [-SortByStorage] + [] ``` -### ParamSet4 -```powershell -Get-SPOContainer [-OwningApplicationId] [-Paged] [[-PagingToken] ] [[-SortByStorage] ] [-ArchiveStatus] [] +### Archive +``` +Get-SPOContainer [-OwningApplicationId] [-Paged] [[-PagingToken] ] + [[-SortByStorage] ] [-ArchiveStatus] + [] +``` + +### Identity +``` +Get-SPOContainer -Identity [] ``` ## DESCRIPTION @@ -50,8 +51,8 @@ You must be a SharePoint Embedded Administrator to run this cmdlet. For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). -> [!NOTE] -> Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet. +> [!NOTE] +> Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet. > The OwningApplicationId for Microsoft Loop is `a187e399-0c36-4b98-8f04-1edc167a0996`. > The OwningApplicationId for Microsoft Designer is `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`. @@ -68,11 +69,11 @@ Example 1 returns the detailed properties of the Container with associated Conta ### Example 2 ```powershell -Get-SPOContainer -OwningApplicationId 423poi45 | ft +Get-SPOContainer -OwningApplicationId 423poi45 | ft ``` Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`. - + ### Example 3 ```powershell @@ -83,7 +84,7 @@ Example 3 uses the `-Paged` command to retrieve a paging token. ### Example 4 ```powershell -Get-SPOContainer -OwningApplicationId 423poi45 -Paged -PagingToken | ft +Get-SPOContainer -OwningApplicationId 423poi45 -Paged -PagingToken | ft ``` Example 4 uses the `-PagingToken` parameter along with the `-Paged` parameter to view more containers that were not displayed in Example 3. @@ -123,18 +124,26 @@ Example 8 returns a tabular list of recently archived containers belonging to th ## PARAMETERS -### -OwningApplicationId +### -ArchiveStatus + +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. +- RecentlyArchived – Displays containers in the "Recently archived" state. +- FullyArchived – Displays containers in the "Fully archived" state. +- Reactivating – Displays containers in the "Reactivating" state. +- NotArchived – Displays active containers + -This parameter specifies the ID of the SharePoint Embedded application. Use the `Get-SPOApplication` command to retrieve the OwningApplicationId. - ```yaml -Type: String -Parameter Sets: (All) +Type: Microsoft.Online.SharePoint.TenantAdministration.SPContainerArchiveStatusFilterProperties +Parameter Sets: Archive Aliases: +Accepted values: NotArchived, FullyArchived, RecentlyArchived, Reactivating, Archived Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -143,10 +152,10 @@ Accept wildcard characters: False ### -Identity Use this parameter to specify the Container ID. - + ```yaml -Type: String -Parameter Sets: ParamSet4, ParamSet5 +Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind +Parameter Sets: Identity Aliases: Applicable: SharePoint Online @@ -157,85 +166,100 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paged +### -OwningApplicationId -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. +This parameter specifies the ID of the SharePoint Embedded application. Use the `Get-SPOApplication` command to retrieve the OwningApplicationId. ```yaml -Type: String -Parameter Sets: ParamSet2, ParamSet3 +Type: System.Guid +Parameter Sets: OwningApplicationId, Sort, Archive Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Paged -### -PagingToken - -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. +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: String -Parameter Sets: ParamSet2, ParamSet3 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: OwningApplicationId, Sort, Archive Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SortByStorage -This parameter can be used when you need to see the list of containers, sorted by storage. +### -PagingToken + +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: String +Type: System.String +Parameter Sets: OwningApplicationId, Sort, Archive +Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchiveStatus - -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. - -• RecentlyArchived – Displays containers in the "Recently archived" state. +### -SortByStorage -• FullyArchived – Displays containers in the "Fully archived" state. +This parameter can be used when you need to see the list of containers, sorted by storage. -• Reactivating – Displays containers in the "Reactivating" state. +```yaml +Type: Microsoft.Online.SharePoint.TenantManagement.SortOrder +Parameter Sets: Sort +Aliases: +Accepted values: Ascending, Descending -• NotArchived – Displays active containers - +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ```yaml -Type: String -Applicable: SharePoint Online +Type: Microsoft.Online.SharePoint.TenantManagement.SortOrder +Parameter Sets: Archive +Aliases: +Accepted values: Ascending, Descending Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainerType.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md index 09a9b84ce..d727777a3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocontainertype applicable: SharePoint Online @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS -Returns one or more container types created in the tenant. +Returns one or more container types created in the tenant. ## SYNTAX @@ -23,18 +23,16 @@ Returns one or more container types created in the tenant. ```powershell Get-SPOContainerType [] ``` -### ParamSet2 -```powershell -Get-SPOContainerType -ContainerTypeId [] +Get-SPOContainerType [[-ContainerTypeId] ] [] ``` ## DESCRIPTION -This cmdlet returns all the container types present in the tenant or details of a specific container type when paired with the `ContainerTypeId` parameter. +This cmdlet returns all the container types present in the tenant or details of a specific container type when paired with the `ContainerTypeId` parameter. You must be a SharePoint Embedded Administrator to run the cmdlet. -While the basic information of container types is displayed to all administrators running this cmdlet, the billing information about a container type is only visible to administrators who also have owner or contributor access on the billing subscription attached to the container type. +While the basic information of container types is displayed to all administrators running this cmdlet, the billing information about a container type is only visible to administrators who also have owner or contributor access on the billing subscription attached to the container type. For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). @@ -43,7 +41,7 @@ For permissions and the most current information about Windows PowerShell for Sh ### Example 1 ```powershell -Get-SPOContainerType +Get-SPOContainerType ``` Example 1 retrieves all the container types present in the tenant and displays container type specific information. @@ -58,20 +56,34 @@ Example 2 returns the detailed properties of container type 4f0af585. ## PARAMETERS ### -ContainerTypeId - + This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online - -Required: True -Position: Named + +Required: False +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainerTypeConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md similarity index 70% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainerTypeConfiguration.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md index f0046307f..ce0d1dd6f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainerTypeConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerTypeConfiguration.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Get-SPOContainertypeConfiguration applicable: SharePoint Online @@ -10,32 +10,30 @@ ms.author: fanyi ms.reviewer: --- -# Get-SPOContainertypeConfiguration +# Get-SPOContainerTypeConfiguration ## SYNOPSIS -Use this cmdlet to read the configuration values set on the container type. +Use this cmdlet to read the configuration values set on the container type. ## SYNTAX -### ParamSet1 - -```powershell +``` Get-SPOContainerTypeConfiguration -ContainerTypeId [] ``` ## DESCRIPTION -The `Get-SPOContainerTypeConfiguration` cmdlet retrieves and returns configuration settings set on a container type created under a SharePoint Embedded application. This can either be the default value or the previously set value on the container type. +The `Get-SPOContainerTypeConfiguration` cmdlet retrieves and returns configuration settings set on a container type created under a SharePoint Embedded application. This can either be the default value or the previously set value on the container type. -You must be a SharePoint Embedded Administrator to run this cmdlet. +You must be a SharePoint Embedded Administrator to run this cmdlet. ## EXAMPLES ### Example 1 ```powershell -Get-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 +Get-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 ``` This example returns a list of configurations set on a container type '4f0af585-8dcc-0000-223d-661eb2c604e4'. @@ -45,9 +43,9 @@ This example returns a list of configurations set on a container type '4f0af585- ### -ContainerTypeId This parameter specifies the ID of the SharePoint Embedded container type. Use the `Get-SPOContainerType` command to retrieve the ContainerTypeId. - + ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -58,10 +56,19 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +### System.Object +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContentEventEmailAddresses.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentEventEmailAddresses.md similarity index 66% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContentEventEmailAddresses.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentEventEmailAddresses.md index e859ded91..09a7dca5c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContentEventEmailAddresses.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentEventEmailAddresses.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocontenteventemailaddresses applicable: SharePoint Online @@ -19,8 +19,8 @@ Retrieves email addresses associated with a specific content event category. If ## SYNTAX -```powershell -Get-SPOContentEventEmailAddresses [-Category] +``` +Get-SPOContentEventEmailAddresses [[-Category] ] [] ``` ## DESCRIPTION @@ -44,22 +44,33 @@ In Example 1, the system will display the email addresses categorized under rans Specifies the content event category. ```yaml -Type: ContentEventCategory +Type: Microsoft.SharePoint.Administration.TenantAdmin.ContentEventCategory Parameter Sets: (All) Aliases: +Accepted values: Unknown, Ransomware, HighVolumeDownload, HighVolumeDelete, HighVolumeShare Applicable: SharePoint Online Required: False -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES ## RELATED LINKS [Remove-SPOContentEventEmailAddresses](Remove-SPOContentEventEmailAddresses.md) -[Set-SPOContentEventEmailAddresses](Set-SPOContentEventEmailAddresses.md) \ No newline at end of file +[Set-SPOContentEventEmailAddresses](Set-SPOContentEventEmailAddresses.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContentSecurityPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentSecurityPolicy.md similarity index 60% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContentSecurityPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentSecurityPolicy.md index cdb1bec18..e7c4d6119 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContentSecurityPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContentSecurityPolicy.md @@ -1,5 +1,5 @@ --- -external help file: +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/get-spocontentsecuritypolicy applicable: SharePoint Online @@ -19,16 +19,31 @@ Returns all sources in the current **Content Security Policy** configuration. ## SYNTAX -### Default - -```powershell -Get-SPOContentSecurityPolicy +``` +Get-SPOContentSecurityPolicy [] ``` ## DESCRIPTION Returns all sources in the current **Content Security Policy** configuration. +## EXAMPLES + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Add-SPOContentSecurityPolicy](Add-SPOContentSecurityPolicy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md similarity index 93% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md index 27eaa04b7..bc559f05e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotAgentInsightsReport.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocopilotagentinsightsreport applicable: SharePoint Online @@ -22,8 +22,9 @@ This cmdlet enables the administrator to check status of all active and availabl ## SYNTAX -```powershell -Get-SPOCopilotAgentInsightsReport [-ReportId ] [-Content ] [-Action ] +``` +Get-SPOCopilotAgentInsightsReport [-ReportId ] [-Action ] + [-Content ] [] ``` ## DESCRIPTION @@ -42,7 +43,7 @@ If this cmdlet is executed without any parameters, it displays the status of all ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOCopilotAgentInsightsReport @@ -50,7 +51,7 @@ Get-SPOCopilotAgentInsightsReport Example 1 enables administrator to view the status of all active and completed reports. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b @@ -58,7 +59,7 @@ Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c7 Example 2 enables administrator to view the Copilot agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`. -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Get-SPOCopilotAgentInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download @@ -68,19 +69,20 @@ Example 3 enables administrator to download the Copilot agent insight report of ## PARAMETERS -### -ReportId +### -Action -It specifies the unique Id of the report to be viewed or downloaded. +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 -Type: Guid +Type: ActionType Parameter Sets: (All) Aliases: +Accepted values: View, Download Applicable: SharePoint Online Required: False Position: Named -Default value: None +Default value: View Accept pipeline input: False Accept wildcard characters: False ``` @@ -126,9 +128,10 @@ If this cmdlet is executed with `-ReportId` as parameter and `-Content` as ` | Copilot agents | Number of Copilot agents on the SharePoint site corresponding to that particular site template. | ```yaml -Type: SPOCopilotAgentInsightType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOCopilotAgentInsightType Parameter Sets: (All) Aliases: +Accepted values: CopilotAgentsOnSites, TopSites, SiteDistribution Applicable: SharePoint Online Required: False @@ -138,19 +141,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Action +### -ReportId -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. +It specifies the unique Id of the report to be viewed or downloaded. ```yaml -Type: ActionType +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: View +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,8 +162,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) -[Start-SPOCopilotAgentInsightsReport](./Start-SPOCopilotAgentInsightsReport.md) \ No newline at end of file +[Start-SPOCopilotAgentInsightsReport](./Start-SPOCopilotAgentInsightsReport.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoOptInStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoOptInStatus.md new file mode 100644 index 000000000..e761de0f7 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoOptInStatus.md @@ -0,0 +1,59 @@ +--- +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/Get-SPOCopilotPromoOptInStatus +applicable: SharePoint Online +title: Get-SPOCopilotPromoOptInStatus +schema: +author: siruvanti +ms.author: siruvanti +ms.reviewer: +--- + +# Get-SPOCopilotPromoOptInStatus + +## SYNOPSIS + +Returns the Opt-In Copilot promo status for the tenant. + +## SYNTAX + +``` +Get-SPOCopilotPromoOptInStatus [] +``` + +## DESCRIPTION + +This cmdlet returns the Opt-In Copilot promo status for the tenant. +If the promo status is enabled, the return value is `True`, otherwise the return value is `False`. + +## EXAMPLES + +### Example 1 + +```powershell +Get-SPOCopilotPromoOptInStatus +``` + +Example 1 returns the value of the Opt-In promo status. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Set-SPOCopilotPromoOptInStatus](./Set-SPOCopilotPromoOptInStatus.md) + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoUsage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoUsage.md new file mode 100644 index 000000000..af54611c6 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCopilotPromoUsage.md @@ -0,0 +1,61 @@ +--- +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/Get-SPOCopilotPromoUsage +applicable: SharePoint Online +title: Get-SPOCopilotPromoUsage +schema: +author: arakesh +ms.author: arakesh +ms.reviewer: +--- + +# Get-SPOCopilotPromoUsage + +## SYNOPSIS + +Returns the count of SharePoint Agent promotion queries used by the tenant. + +## SYNTAX + +``` +Get-SPOCopilotPromoUsage [] +``` + +## DESCRIPTION + +This cmdlet retrieves the number of SharePoint Agent promotion queries used by the tenant each month, starting the month tenant qualified for trial. +It provides a monthly breakdown of query usage, helping admins track consumption of the promotion queries over time. + +## EXAMPLES + +### Example 1 + +```powershell +Get-SPOCopilotPromoUsage +``` + +Example 1 returns SharePoint Agent promotion queries usage by month. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-SPOCopilotPromoOptInStatus](./Get-SPOCopilotPromoOptInStatus.md) + +[Set-SPOCopilotPromoOptInStatus](./Set-SPOCopilotPromoOptInStatus.md) + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMoveReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMoveReport.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMoveReport.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMoveReport.md index b14d55f22..eccc57d01 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMoveReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMoveReport.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocrossgeomovereport applicable: SharePoint Online @@ -18,8 +18,9 @@ Provides a report of objects moved between geo locations. ## SYNTAX -```powershell -Get-SPOCrossGeoMoveReport -MoveJobType [-Limit ] [-MoveStartTime ] [-MoveEndTime ] [-MoveState ] [-MoveDirection ] [] +``` +Get-SPOCrossGeoMoveReport [-Limit ] [-MoveStartTime ] [-MoveEndTime ] + -MoveJobType [-MoveState ] [-MoveDirection ] [] ``` ## DESCRIPTION @@ -38,32 +39,32 @@ This example returns the failed site moves between geo locations. ## PARAMETERS -### -MoveJobType - -The type of job to limit the report to. Valid values are: +### -Limit -* GroupMove -* SiteMove -* UserMove +Limit the number of items to return for the report. ```yaml -Type: JobType +Type: System.UInt32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Limit +### -MoveDirection -Limit the number of items to return for the report. +The direction of the move to limit the report to. Valid values are: + +* All +* MoveIn +* MoveOut ```yaml -Type: uint32 +Type: Microsoft.Online.SharePoint.PowerShell.MoveDirection Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -74,12 +75,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MoveStartTime +### -MoveEndTime -The start time to limit the move report to. +The end time to limit the move report to. ```yaml -Type: datetime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -90,38 +91,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MoveEndTime +### -MoveJobType -The end time to limit the move report to. +The type of job to limit the report to. Valid values are: + +* GroupMove +* SiteMove +* UserMove ```yaml -Type: datetime +Type: Microsoft.Online.SharePoint.PowerShell.JobType Parameter Sets: (All) Aliases: +Accepted values: UserMove, GroupMove, SiteMove Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MoveState - -The type of state to limit the report to. Valid values are: +### -MoveStartTime -* All -* Failed -* InProgress -* NotStarted -* NotSupported -* Queued -* Rescheduled -* Stopped -* Success +The start time to limit the move report to. ```yaml -Type: MoveState +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -132,18 +128,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MoveDirection +### -MoveState -The direction of the move to limit the report to. Valid values are: +The type of state to limit the report to. Valid values are: * All -* MoveIn -* MoveOut +* Failed +* InProgress +* NotStarted +* NotSupported +* Queued +* Rescheduled +* Stopped +* Success ```yaml -Type: MoveDirection +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 @@ -156,4 +159,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md index 227bbc77a..819e3d62e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoMovedUsers.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocrossgeomovedusers applicable: SharePoint Online @@ -18,7 +18,7 @@ In a multi-geo tenant returns the SharePoint Online user (or users) that had bee ## SYNTAX -```powershell +``` Get-SPOCrossGeoMovedUsers -Direction [] ``` @@ -28,7 +28,7 @@ This cmdlet allows you to get the moved users out and in the current SPO Site. I ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOCrossGeoMovedUsers -Direction MoveIn @@ -36,7 +36,7 @@ Get-SPOCrossGeoMovedUsers -Direction MoveIn Get the cross users that have been moved in the current SPO site -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOCrossGeoMovedUsers -Direction MoveOut @@ -55,7 +55,7 @@ Possible values - MoveOut ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Accepted values: MoveIn, MoveOut @@ -72,8 +72,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md index 684cadc62..5da316199 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossGeoUsers.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocrossgeousers applicable: SharePoint Online @@ -18,7 +18,7 @@ Returns the SharePoint Online users in a multi-geo tenant that match the criteri ## SYNTAX -```Powershell +``` Get-SPOCrossGeoUsers -ValidDataLocation [] ``` @@ -28,7 +28,7 @@ The Get-SPOCrossGeoUsers cmdlet is used to return the SharePoint Online users th ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```Powershell Get-SPOCrossGeoUsers -ValidDataLocation $true @@ -36,7 +36,7 @@ Get-SPOCrossGeoUsers -ValidDataLocation $true Returns all of the SharePoint Online users in a multi-geo tenant and validates the data location. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```Powershell Get-SPOCrossGeoUsers @@ -44,7 +44,7 @@ Get-SPOCrossGeoUsers Returns all of the SharePoint Online users in a multi-geo tenant without validating data location. -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```Powershell Get-SPOCrossGeoUsers -ValidDataLocation $true | where {$_.UserPrincipalName -eq 'jane@contoso.com'} @@ -62,7 +62,7 @@ Use this parameter to validate the location of the data. The acceptable values f - $True ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -78,9 +78,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossTenantCompatibilityStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossTenantCompatibilityStatus.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md index 3699823ee..1fca492ed 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossTenantCompatibilityStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantCompatibilityStatus.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocrosstenantcompatibilitystatus applicable: SharePoint Online @@ -18,13 +18,13 @@ Determines the compatibility with the partner tenant. ## SYNTAX -```powershell -Get-SPOCrossTenantCompatibilityStatus -PartnerCrossTenantHostUrl [] +``` +Get-SPOCrossTenantCompatibilityStatus [-PartnerCrossTenantHostUrl] [] ``` ## DESCRIPTION -This cmdlet allows you to determine the compatibility with the partner tenant before cross-tenant migration. You must be a SharePoint Administrator to run it. +This cmdlet allows you to determine the compatibility with the partner tenant before cross-tenant migration. You must be a SharePoint Administrator to run it. > [!NOTE] > You must run this command on the source tenant only. @@ -45,13 +45,13 @@ Gets the compatibility status with the partner tenant Contoso. 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -61,6 +61,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantGroupContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantGroupContentMoveState.md new file mode 100644 index 000000000..f9db8d90a --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantGroupContentMoveState.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOCrossTenantGroupContentMoveState + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### MoveReport (Default) +``` +Get-SPOCrossTenantGroupContentMoveState -PartnerCrossTenantHostUrl [-Limit ] + [-MoveStartTime ] [-MoveEndTime ] [-MoveState ] + [-MoveDirection ] [-PartnerRole ] [] +``` + +### SourceGroupAlias +``` +Get-SPOCrossTenantGroupContentMoveState -PartnerCrossTenantHostUrl -SourceGroupAlias + [-PartnerRole ] [] +``` + +### SiteMoveId +``` +Get-SPOCrossTenantGroupContentMoveState -PartnerCrossTenantHostUrl -SiteMoveId + [-PartnerRole ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Limit +{{ Fill Limit Description }} + +```yaml +Type: System.UInt32 +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveDirection +{{ Fill MoveDirection Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.MoveDirection +Parameter Sets: MoveReport +Aliases: +Accepted values: MoveOut, MoveIn, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveEndTime +{{ Fill MoveEndTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveStartTime +{{ Fill MoveStartTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveState +{{ Fill MoveState Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.MoveState +Parameter Sets: MoveReport +Aliases: +Accepted values: NotStarted, InProgress, Success, Failed, Stopped, Queued, NotSupported, Rescheduled, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerCrossTenantHostUrl +{{ Fill PartnerCrossTenantHostUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerRole +{{ Fill PartnerRole Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole +Parameter Sets: (All) +Aliases: +Accepted values: None, Source, Target + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteMoveId +{{ Fill SiteMoveId Description }} + +```yaml +Type: System.Guid +Parameter Sets: SiteMoveId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceGroupAlias +{{ Fill SourceGroupAlias Description }} + +```yaml +Type: System.String +Parameter Sets: SourceGroupAlias +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossTenantHostUrl.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantHostUrl.md similarity index 76% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossTenantHostUrl.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantHostUrl.md index 3abad4399..333b4faf3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossTenantHostUrl.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantHostUrl.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spocrosstenanthosturl applicable: SharePoint Online @@ -18,8 +18,8 @@ Returns the cross-tenant host URL. ## SYNTAX -```powershell -Get-SPOCrossTenantHostUrl [] +``` +Get-SPOCrossTenantHostUrl [] ``` ## DESCRIPTION @@ -42,7 +42,17 @@ This command returns the cross-tenant host URL. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationship.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationship.md new file mode 100644 index 000000000..4e7abb921 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationship.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOCrossTenantRelationship + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOCrossTenantRelationship [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByPartner.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByPartner.md new file mode 100644 index 000000000..ca1375dda --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByPartner.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOCrossTenantRelationshipByPartner + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOCrossTenantRelationshipByPartner [-PartnerCrossTenantHostUrl] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -PartnerCrossTenantHostUrl +{{ Fill PartnerCrossTenantHostUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByScenario.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByScenario.md similarity index 63% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByScenario.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByScenario.md index 34055e674..fd86682c5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByScenario.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantRelationshipByScenario.md @@ -1,36 +1,28 @@ --- -external help file: sharepointonline.xml +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/Get-SPOTenantOrgRelationByScenario -applicable: SharePoint Online -title: Get-SPOTenantOrgRelationByScenario +online version: schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: --- -# Get-SPOTenantOrgRelationByScenario +# Get-SPOCrossTenantRelationshipByScenario ## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. +{{ Fill in the Synopsis }} ## SYNTAX -```powershell -Get-SPOTenantOrgRelationByScenario [-Scenario] [-PartnerRole] +``` +Get-SPOCrossTenantRelationshipByScenario [-Scenario] [-PartnerRole] [] ``` ## DESCRIPTION - {{ Fill in the Description }} ## EXAMPLES ### Example 1 - ```powershell PS C:\> {{ Add example code here }} ``` @@ -40,11 +32,10 @@ PS C:\> {{ Add example code here }} ## PARAMETERS ### -PartnerRole - {{ Fill PartnerRole Description }} ```yaml -Type: OrgRelationRole +Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole Parameter Sets: (All) Aliases: Accepted values: None, Source, Target @@ -57,11 +48,10 @@ Accept wildcard characters: False ``` ### -Scenario - {{ Fill Scenario Description }} ```yaml -Type: OrgRelationScenario +Type: Microsoft.SharePoint.Client.Administration.OrgRelationScenario Parameter Sets: (All) Aliases: Accepted values: None, MnA @@ -74,8 +64,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantSiteContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantSiteContentMoveState.md new file mode 100644 index 000000000..59043fe64 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantSiteContentMoveState.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOCrossTenantSiteContentMoveState + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### MoveReport (Default) +``` +Get-SPOCrossTenantSiteContentMoveState -PartnerCrossTenantHostUrl [-Limit ] + [-MoveStartTime ] [-MoveEndTime ] [-MoveState ] + [-MoveDirection ] [-PartnerRole ] [] +``` + +### SourceSiteUrl +``` +Get-SPOCrossTenantSiteContentMoveState -PartnerCrossTenantHostUrl -SourceSiteUrl + [-PartnerRole ] [] +``` + +### SiteMoveId +``` +Get-SPOCrossTenantSiteContentMoveState -PartnerCrossTenantHostUrl -SiteMoveId + [-PartnerRole ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Limit +{{ Fill Limit Description }} + +```yaml +Type: System.UInt32 +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveDirection +{{ Fill MoveDirection Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.MoveDirection +Parameter Sets: MoveReport +Aliases: +Accepted values: MoveOut, MoveIn, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveEndTime +{{ Fill MoveEndTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveStartTime +{{ Fill MoveStartTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveState +{{ Fill MoveState Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.MoveState +Parameter Sets: MoveReport +Aliases: +Accepted values: NotStarted, InProgress, Success, Failed, Stopped, Queued, NotSupported, Rescheduled, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerCrossTenantHostUrl +{{ Fill PartnerCrossTenantHostUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerRole +{{ Fill PartnerRole Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole +Parameter Sets: (All) +Aliases: +Accepted values: None, Source, Target + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteMoveId +{{ Fill SiteMoveId Description }} + +```yaml +Type: System.Guid +Parameter Sets: SiteMoveId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSiteUrl +{{ Fill SourceSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: SourceSiteUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantUserContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantUserContentMoveState.md new file mode 100644 index 000000000..0f07ba292 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOCrossTenantUserContentMoveState.md @@ -0,0 +1,199 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOCrossTenantUserContentMoveState + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### MoveReport (Default) +``` +Get-SPOCrossTenantUserContentMoveState -PartnerCrossTenantHostUrl [-Limit ] + [-MoveStartTime ] [-MoveEndTime ] [-MoveState ] + [-MoveDirection ] [-PartnerRole ] [] +``` + +### SourceUserPrincipalName +``` +Get-SPOCrossTenantUserContentMoveState -PartnerCrossTenantHostUrl -SourceUserPrincipalName + [-PartnerRole ] [] +``` + +### SiteMoveId +``` +Get-SPOCrossTenantUserContentMoveState -PartnerCrossTenantHostUrl -SiteMoveId + [-PartnerRole ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Limit +{{ Fill Limit Description }} + +```yaml +Type: System.UInt32 +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveDirection +{{ Fill MoveDirection Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.MoveDirection +Parameter Sets: MoveReport +Aliases: +Accepted values: MoveOut, MoveIn, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveEndTime +{{ Fill MoveEndTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveStartTime +{{ Fill MoveStartTime Description }} + +```yaml +Type: System.DateTime +Parameter Sets: MoveReport +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MoveState +{{ Fill MoveState Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.MoveState +Parameter Sets: MoveReport +Aliases: +Accepted values: NotStarted, InProgress, Success, Failed, Stopped, Queued, NotSupported, Rescheduled, All + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerCrossTenantHostUrl +{{ Fill PartnerCrossTenantHostUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartnerRole +{{ Fill PartnerRole Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole +Parameter Sets: (All) +Aliases: +Accepted values: None, Source, Target + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteMoveId +{{ Fill SiteMoveId Description }} + +```yaml +Type: System.Guid +Parameter Sets: SiteMoveId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceUserPrincipalName +{{ Fill SourceUserPrincipalName Description }} + +```yaml +Type: System.String +Parameter Sets: SourceUserPrincipalName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataAccessGovernanceInsight.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODataAccessGovernanceInsight.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataAccessGovernanceInsight.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODataAccessGovernanceInsight.md index 0c6782dcd..aeaae3b64 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataAccessGovernanceInsight.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODataAccessGovernanceInsight.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spodataaccessgovernanceinsight applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Get-SPODataAccessGovernanceInsight schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -21,7 +21,8 @@ Lists various 'Data Access Governance' (DAG) reports in SharePoint admin center. ### GetAllReportsParameterSet ``` -Get-SPODataAccessGovernanceInsight -ReportEntity [-Workload ] [-ReportType ] [] +Get-SPODataAccessGovernanceInsight -ReportEntity [-Workload ] + [-ReportType ] [] ``` ### GetReportParameterSet @@ -50,7 +51,7 @@ The above cmdlet fetches all DAG reports about 'Everyone except external users' Specifies the entity that could cause oversharing and hence tracked by these reports. ```yaml -Type: ReportEntityEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.ReportEntityEnum Parameter Sets: GetAllReportsParameterSet Aliases: Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers, PermissionsReport @@ -67,7 +68,7 @@ Accept wildcard characters: False Specifies the ID of the particular report to be fetched. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: GetReportParameterSet Aliases: @@ -83,7 +84,7 @@ Accept wildcard characters: False Specifies the time period of data of the reports to be fetched. A 'Snapshot' report will have the latest data as of the report generation time. A 'RecentActivity' report will be based on data in the last 28 days. ```yaml -Type: ReportTypeEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.ReportTypeEnum Parameter Sets: GetAllReportsParameterSet Aliases: Accepted values: Snapshot, RecentActivity @@ -113,7 +114,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODataEncryptionPolicy.md similarity index 91% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODataEncryptionPolicy.md index d7ff12f74..03e2e8c21 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODataEncryptionPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spodataencryptionpolicy applicable: SharePoint Online @@ -18,7 +18,7 @@ ms.reviewer: ## SYNTAX -```powershell +``` Get-SPODataEncryptionPolicy ``` @@ -26,7 +26,7 @@ Get-SPODataEncryptionPolicy Use the Get-DataEncryptionPolicy cmdlet to view customer encryption status for your geo tenant. -For more information, see [Controlling your data in Office 365 using Customer Key](https://learn.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) +For more information, see [Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) ## EXAMPLES @@ -37,7 +37,7 @@ Get-SPODataEncryptionPolicy ``` The output from this cmdlet includes: - + - The URI of the primary key. - The URI of the secondary key. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedContainer.md similarity index 91% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedContainer.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedContainer.md index 4d14833fc..06672a804 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedContainer.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spodeletedcontainer applicable: SharePoint Online @@ -30,7 +30,7 @@ The `Get-SPODeletedContainer` cmdlet returns a list of all deleted File Storage You must be a SharePoint Administrator to run this cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -40,7 +40,7 @@ For permissions and the most current information about Windows PowerShell for Sh Get-SPODeletedContainer ``` -This example returns a list of the `ContainerId`, `ContainerName`, and `CreatedDate` of all deleted Containers in the Recycle Bin. +This example returns a list of the `ContainerId`, `ContainerName`, and `CreatedDate` of all deleted Containers in the Recycle Bin. ## PARAMETERS @@ -49,11 +49,19 @@ This example returns a list of the `ContainerId`, `ContainerName`, and `CreatedD This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOContainer](Get-SPOContainer.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md index 762f6056e..8acaaf822 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODeletedSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spodeletedsite applicable: SharePoint Online @@ -18,16 +18,16 @@ Returns all deleted site collections from the Recycle Bin. ## SYNTAX -### ParameterSetPersonalSitesOnly - -```powershell -Get-SPODeletedSite [[-Identity] ] [-IncludeOnlyPersonalSite] [-Limit ] [] +### ParameterSetAllSites (Default) +``` +Get-SPODeletedSite [[-Identity] ] [-Limit ] [-IncludePersonalSite] + [] ``` -### ParameterSetAllSites - -```powershell -Get-SPODeletedSite [[-Identity] ] [-IncludePersonalSite] [-Limit ] [] +### ParameterSetPersonalSitesOnly +``` +Get-SPODeletedSite [[-Identity] ] [-Limit ] [-IncludeOnlyPersonalSite] + [] ``` ## DESCRIPTION @@ -46,11 +46,11 @@ To restore the site or site collections, forward the results to the `Restore-SPO You must be a SharePoint Online administrator and be a site collection administrator for the deleted site collections to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Get-SPODeletedSite -IncludePersonalSite @@ -60,37 +60,37 @@ The command in this example returns all deleted site collections from the Recycl ## PARAMETERS -### -IncludeOnlyPersonalSite +### -Identity -Use this switch parameter to only include Personal Sites in the returned results. +Specifies the URL of the deleted site collection to be returned. ```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetPersonalSitesOnly +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: Named +Required: False +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Identity +### -IncludeOnlyPersonalSite -Specifies the URL of the deleted site collection to be returned. +Use this switch parameter to only include Personal Sites in the returned results. ```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ParameterSetPersonalSitesOnly Aliases: Applicable: SharePoint Online -Required: False -Position: 1 +Required: True +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -99,7 +99,7 @@ Accept wildcard characters: False Use this switch parameter to include Personal Sites with the returned results. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ParameterSetAllSites Aliases: Applicable: SharePoint Online @@ -119,7 +119,7 @@ To retrieve all site collections, use ALL. The default value is 200. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -143,7 +143,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODisableSpacesActivation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODisableSpacesActivation.md new file mode 100644 index 000000000..364b675a7 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPODisableSpacesActivation.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPODisableSpacesActivation + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPODisableSpacesActivation [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOEnterpriseAppInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOEnterpriseAppInsightsReport.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md index 04eccf6d7..a7a08f797 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOEnterpriseAppInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOEnterpriseAppInsightsReport.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spoenterpriseappinsightsreport applicable: SharePoint Online @@ -19,8 +19,8 @@ This cmdlet enables the administrator to check status of all active and availabl ## SYNTAX -```powershell -Get-SPOEnterpriseAppInsightsReport [-ReportId ] [-Action ] +``` +Get-SPOEnterpriseAppInsightsReport [-ReportId ] [-Action ] [] ``` ## DESCRIPTION @@ -46,13 +46,13 @@ If this cmdlet is executed with `-ReportId` as parameter, the top 100 records of | RequestVoulme | The number of times the 3P application accessed the given SharePoint site. | If this cmdlet is executed with both the parameters, i.e. `-ReportId` and `-Action`, and if the value of `-Action` is set as `View`, it will display the same result as described above. If the value of `-Action` is set to `Download`, it will download the full report in CSV format to the same path from where the command was run. - + > [!NOTE] > All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOEnterpriseAppInsightsReport @@ -60,7 +60,7 @@ Get-SPOEnterpriseAppInsightsReport Example 1 enables administrator to view the status of all active and completed reports. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOEnterpriseAppInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b @@ -68,7 +68,7 @@ Get-SPOEnterpriseAppInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c Example 2 enables administrator to view the enterprise application insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Get-SPOEnterpriseAppInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download @@ -78,16 +78,17 @@ Example 3 enables administrator to download the enterprise application insights ## PARAMETERS -### -ReportId +### -Action -It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded. +It is an optional parameter, and it specifies whether to view or download a specific report. ```yaml -Type: Guid +Type: Microsoft.Online.SharePoint.PowerShell.GetSPOEnterpriseAppInsightsReport+ActionType Parameter Sets: (All) Aliases: +Accepted values: View, Download Applicable: SharePoint Online - + Required: False Position: Named Default value: None @@ -95,16 +96,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Action +### -ReportId -It is an optional parameter, and it specifies whether to view or download a specific report. +It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded. ```yaml -Type: ActionType +Type: Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online - + Required: False Position: Named Default value: None @@ -113,11 +114,20 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## NOTES ## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) -[Start-SPOEnterpriseAppInsightsReport](./Start-SPOEnterpriseAppInsightsReport.md) \ No newline at end of file +[Start-SPOEnterpriseAppInsightsReport](./Start-SPOEnterpriseAppInsightsReport.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md index a1b67c935..a2ef3e912 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOExternalUser.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spoexternaluser applicable: SharePoint Online @@ -18,8 +18,10 @@ Returns external users in the tenant. ## SYNTAX -```powershell -Get-SPOExternalUser [[-Position] ] [[-PageSize] ] [[-Filter] ] [[-SortOrder] ] [[-SiteUrl] ] [-ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount ] [] +``` +Get-SPOExternalUser [[-Position] ] [[-PageSize] ] [[-Filter] ] [[-SortOrder] ] + [[-SiteUrl] ] [-ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount ] + [] ``` ## DESCRIPTION @@ -30,7 +32,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOExternalUser -Position 0 -PageSize 2 @@ -38,7 +40,7 @@ Get-SPOExternalUser -Position 0 -PageSize 2 Example 1 returns the first two external users in the collection. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOExternalUser -Position 2 -PageSize 2 @@ -46,7 +48,7 @@ Get-SPOExternalUser -Position 2 -PageSize 2 Example 2 returns two external users from the third page of the collection. -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Get-SPOExternalUser -Position 0 -PageSize 30 -SiteUrl https://contoso.sharepoint.com @@ -61,7 +63,7 @@ Example 3 returns the first 30 users that match the SiteUrl ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoAdministrator.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoAdministrator.md index 1aba45b0c..e6d810da0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoAdministrator.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spogeoadministrator applicable: SharePoint Online @@ -18,14 +18,14 @@ This cmdlet returns the SharePoint Online user or security group accounts with G ## SYNTAX -```powershell +``` Get-SPOGeoAdministrator [] ``` ## DESCRIPTION You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see [Cmdlet parameter sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). +For more information about how to use parameter sets, see [Cmdlet parameter sets](/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). The `Get-SPOGeoAdministrator` cmdlet has a single parameter set and matches a user or a list of users which has the ability to do changes globally in the geo location that you are connected to. @@ -51,11 +51,21 @@ This cmdlet will output a SharePoint Online user or security group that is Multi This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Add or remove a geo administrator](https://learn.microsoft.com/Office365/Enterprise/add-a-sharepoint-geo-admin) +[Add or remove a geo administrator](/Office365/Enterprise/add-a-sharepoint-geo-admin) -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoMoveCrossCompatibilityStatus.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoMoveCrossCompatibilityStatus.md index 733d3f3d2..49d6ce440 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoMoveCrossCompatibilityStatus.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spogeomovecrosscompatibilitystatus applicable: SharePoint Online @@ -18,7 +18,7 @@ This cmdlet returns the compatibility status between geographic locations. ## SYNTAX -```powershell +``` Get-SPOGeoMoveCrossCompatibilityStatus [] ``` @@ -53,10 +53,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md index 8bbc96c16..d8db0e43f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOGeoStorageQuota.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spogeostoragequota applicable: SharePoint Online @@ -18,7 +18,7 @@ This cmdlet gets the storage quota on a multi-geo tenant. ## SYNTAX -```Powershell +``` Get-SPOGeoStorageQuota [-AllLocations] [] ``` @@ -30,7 +30,7 @@ This cmdlet requires a connection to a multi-geo tenant to run correctly. You mu ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```Powershell Get-SPOGeoStorageQuota -AllLocations @@ -38,7 +38,7 @@ Get-SPOGeoStorageQuota -AllLocations Get the storage size quota of all locations. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```Powershell Get-SPOGeoStorageQuota @@ -53,7 +53,7 @@ Get the storage size quota of the current location. Use this parameter to retrieve the storage size quota of all locations. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -69,9 +69,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHideDefaultThemes.md similarity index 63% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHideDefaultThemes.md index 5b2595958..f8547bb28 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHideDefaultThemes.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spohidedefaultthemes applicable: SharePoint Online @@ -16,6 +16,12 @@ ms.reviewer: Queries the current SPOHideDefaultThemes setting. SPO stands for SharePoint Online. +## SYNTAX + +``` +Get-SPOHideDefaultThemes [] +``` + ## DESCRIPTION The **Get-SPOHideDefaultThemes** cmdlet retrieves the current **Set-SPOHideDefaultThemes** setting. You might want to use this cmdlet in a PowerShell script to read the setting and then take different actions based on whether the default themes are hidden. This cmdlet does not have any parameters. @@ -31,14 +37,23 @@ The **Get-SPOHideDefaultThemes** cmdlet retrieves the current **Set-SPOHideDefau Get-SPOHideDefaultThemes ``` +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Set-SPOHideDefaultThemes](Set-SPOHideDefaultThemes.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHomeSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHomeSite.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHomeSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHomeSite.md index 255bbaef9..6cf101e35 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHomeSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHomeSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spohomesite applicable: SharePoint Online @@ -18,7 +18,7 @@ Returns the home site url for your tenant. ## SYNTAX -```powershell +``` Get-SPOHomeSite [] ``` @@ -42,4 +42,14 @@ This example returns the home site url for your tenant. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md index e5368c25c..f7f8d3be8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOHubSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spohubsite applicable: SharePoint Online @@ -18,9 +18,8 @@ Lists hub sites or hub site information. ## SYNTAX -```powershell -Get-SPOHubSite [-Identity] -[] +``` +Get-SPOHubSite [[-Identity] ] [] ``` ## DESCRIPTION @@ -30,7 +29,7 @@ Lists all hub sites found on the SharePoint tenant. If you provide **-Identity** If the hub site doesn't exist, this cmdlet returns a "File not found" error. > [!NOTE] -> If a deleted hub site appears in the output of this cmdlet you may not have run [Unregister-SPOHubSite](https://learn.microsoft.com/powershell/module/sharepoint-online/unregister-spohubsite) on the deleted hub site. +> If a deleted hub site appears in the output of this cmdlet you may not have run [Unregister-SPOHubSite](/powershell/module/sharepoint-online/unregister-spohubsite) on the deleted hub site. ## EXAMPLES @@ -63,19 +62,36 @@ This example begins with the online-marketing site. The cmdlet finds the associa ## PARAMETERS +## PARAMETERS + ### -Identity URL of the hub site. If not specified, the cmdlet lists all hub sites in the tenant. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersInsightsReport.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersInsightsReport.md index 2b155438d..fdb7561cf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersInsightsReport.md @@ -1,5 +1,5 @@ ---- -external help file: sharepointonline.xml +--- +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/get-spoinformationbarriersinsightsreport applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Get-SPOInformationBarriersInsightsReport schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -19,8 +19,9 @@ Enables the SharePoint Administrator to check status of all active and completed ## SYNTAX -```powershell -Get-SPOInformationBarriersInsightsReport [-ReportId ] [-Section ] [-Action ] [-Service ] [-FullDetails] [] +``` +Get-SPOInformationBarriersInsightsReport [-ReportId ] [-Section ] [-Action ] + [-Service ] [] ``` ## DESCRIPTION @@ -64,7 +65,7 @@ Specifies whether the report is displayed in the console or downloaded as a file - If set to `Download`, the report is saved as a CSV file in the directory where the command is run. ```yaml -Type: ActionType +Type: Microsoft.Online.SharePoint.PowerShell.ActionType Parameter Sets: (All) Aliases: Accepted values: View, Download @@ -76,28 +77,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FullDetails - -It is an optional parameter and allows to download a CSV file containing up to 1 million records. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ReportId It specifies the unique Id of the report to be viewed or downloaded. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -113,7 +98,7 @@ Accept wildcard characters: False This parameters helps to view the details of the specified mode. ```yaml -Type: SectionType +Type: Microsoft.Online.SharePoint.PowerShell.SectionType Parameter Sets: (All) Aliases: Accepted values: Explicit, Implicit, Open, OwnerModerated, ModeDistribution, Mixed @@ -130,7 +115,7 @@ Accept wildcard characters: False This parameter helps to identify the type of service to view the summary of the insight report of that specified service. ```yaml -Type: ServiceType +Type: Microsoft.Online.SharePoint.PowerShell.ServiceType Parameter Sets: (All) Aliases: Accepted values: OneDrive, SharePoint @@ -143,8 +128,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md new file mode 100644 index 000000000..afc0af17f --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOInformationBarriersPolicyComplianceReport + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOInformationBarriersPolicyComplianceReport [-ReportID ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ReportID +{{ Fill ReportID Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOIsCommSite.md similarity index 53% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOIsCommSite.md index ce9c1ec84..d81b98e6c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOIsCommSite.md @@ -1,46 +1,52 @@ --- -external help file: sharepointonline.xml +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/Get-SPOTenantOrgRelation -applicable: SharePoint Online -title: Get-SPOTenantOrgRelation +online version: schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: --- -# Get-SPOTenantOrgRelation +# Get-SPOIsCommSite ## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. +{{ Fill in the Synopsis }} ## SYNTAX -```powershell -Get-SPOTenantOrgRelation [] +``` +Get-SPOIsCommSite -SiteUrl [] ``` ## DESCRIPTION - {{ Fill in the Description }} ## EXAMPLES ### Example 1 - ```powershell - Get-SPOTenantOrgRelation +PS C:\> {{ Add example code here }} ``` {{ Add example description here }} ## PARAMETERS -### CommonParameters +### -SiteUrl +{{ Fill SiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOKnowledgeHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOKnowledgeHubSite.md new file mode 100644 index 000000000..0980c1633 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOKnowledgeHubSite.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOKnowledgeHubSite + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOKnowledgeHubSite [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOLandingSites.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOLandingSites.md new file mode 100644 index 000000000..25b7a5356 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOLandingSites.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOLandingSites + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOLandingSites -UserId [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -UserId +{{ Fill UserId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListDesign.md similarity index 96% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListDesign.md index eeb7aa122..16e51b0b6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListDesign.md @@ -45,7 +45,7 @@ This example and sample response show how to get list design details. The ID of the list design to retrieve. ```yaml -Type: SPOListDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOListDesignPipeBind Parameter Sets: (All) Aliases: diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListFileVersionBatchDeleteJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionBatchDeleteJobProgress.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListFileVersionBatchDeleteJobProgress.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionBatchDeleteJobProgress.md index a49e0c880..d5e2172dd 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListFileVersionBatchDeleteJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionBatchDeleteJobProgress.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spolistfileversionbatchdeletejobprogress applicable: SharePoint Online @@ -19,8 +19,9 @@ Gets the progress of a trim job for a site collection. ## SYNTAX -```powershell -Get-SPOListFileVersionBatchDeleteJobProgress [-Site] [-List] [] +``` +Get-SPOListFileVersionBatchDeleteJobProgress [-Site] -List + [] ``` ## DESCRIPTION @@ -39,34 +40,35 @@ Example 1 gets the progress of a trim job for a document library called "Documen ## PARAMETERS -### -Site +### -List -Specifies the URL of the site. +The document library name or Id. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -List +### -Site -The document library name or Id. +Specifies the URL of the site. ```yaml -Type: SPOListPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) - +Aliases: +Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -74,6 +76,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +### Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Remove-SPOListFileVersionBatchDeleteJob](Remove-SPOListFileVersionBatchDeleteJob.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListFileVersionExpirationReportJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionExpirationReportJobProgress.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListFileVersionExpirationReportJobProgress.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionExpirationReportJobProgress.md index a3fc9d2f7..9d7bef139 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListFileVersionExpirationReportJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListFileVersionExpirationReportJobProgress.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spolistfileversionexpirationreportjobprogress applicable: SharePoint Online @@ -19,8 +19,9 @@ Gets the status for a file version expiration report generation job for a docume ## SYNTAX -```powershell -Get-SPOListFileVersionExpirationReportJobProgress [-Site] [-List] [-ReportUrl ] [] +``` +Get-SPOListFileVersionExpirationReportJobProgress [-Site] -List + -ReportUrl [] ``` ## DESCRIPTION @@ -39,29 +40,30 @@ Example 1 gets the status for a file version expiration report generation job fo ## PARAMETERS -### -Site +### -List -Specifies the URL of the site. +The document library name or Id. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -List +### -ReportUrl -The document library name or Id. +The URL of the report to get the job status on. ```yaml -Type: SPOListPipeBind +Type: System.String Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -70,18 +72,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportUrl +### -Site -The URL of the report to get the job status on. +Specifies the URL of the site. ```yaml -Type: string +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) - +Aliases: +Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -89,6 +92,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +### Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [New-SPOListFileVersionExpirationReportJob](New-SPOListFileVersionExpirationReportJob.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListVersionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListVersionPolicy.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListVersionPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListVersionPolicy.md index 61bd0c2ff..bd88b7263 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOListVersionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOListVersionPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spolistversionpolicy applicable: SharePoint Online @@ -19,8 +19,8 @@ Gets the version policy setting on the document library. ## SYNTAX -```powershell -Get-SPOListVersionPolicy [-Site] [-List] [] +``` +Get-SPOListVersionPolicy [-Site] -List [] ``` ## DESCRIPTION @@ -39,34 +39,35 @@ Example 1 gets the version policy setting on the document library called "Docume ## PARAMETERS -### -Site +### -List -Specifies the URL of the site. +The document library name or Id. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -List +### -Site -The document library name or Id. +Specifies the URL of the site. ```yaml -Type: SPOListPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) - +Aliases: +Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -74,6 +75,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +### Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Set-SPOListVersionPolicy](Set-SPOListVersionPolicy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMalwareFile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md similarity index 76% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMalwareFile.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md index 9945e647e..fe63d054e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMalwareFile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFile.md @@ -1,67 +1,80 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spomalwarefile -applicable: SharePoint Online -title: Get-SPOMalwareFile -schema: 2.0.0 -author: vinandi -ms.author: vinandi -ms.reviewer: ---- - -# Get-SPOMalwareFile - -## SYNOPSIS - -Extracts and displays the malware-related information of an infected file stored in SharePoint. - - -## SYNTAX - -```powershell -Get-SPOMalwareFile -FileUri [] -``` - -## DESCRIPTION - -The `Get-SPOMalwareFile` cmdlet runs on a single file. If the file is malware-infected then it returns an object of the type `SPOMalwareFile` which contains siteURL, filePath, malwareStatus flag, and malwareInfo (if applicable). You must be a SharePoint Online administrator to run the `Get-SPOMalwareFile` cmdlet. Note that this cmdlet does not work on files that are not malware-infected. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). - -## EXAMPLES - -### EXAMPLE 1 - -```powershell - Get-SPOMalwareFile -FileUri "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" -``` - -Example 1 returns an object of the type `SPOMalwareFile` which contains siteURL, filePath, malwareStatus flag, and malwareInfo (if applicable). - -## PARAMETERS - -### -FileUri - -Full URL for the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -``` - -## NOTES - -The `Get-SPOMalwareFile` cmdlet returns an object of the type `SPOMalwareFile`. To get the file stream of the infected file, pass this object as a parameter to the `Get-SPOMalwareFileContent` cmdlet. - -## RELATED LINKS - -[Get-SPOMalwareFileContent](Get-SPOMalwareFileContent.md) - -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) +--- +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/get-spomalwarefile +applicable: SharePoint Online +title: Get-SPOMalwareFile +schema: 2.0.0 +author: vinandi +ms.author: vinandi +ms.reviewer: +--- + +# Get-SPOMalwareFile + +## SYNOPSIS + +Extracts and displays the malware-related information of an infected file stored in SharePoint. + + +## SYNTAX + +``` +Get-SPOMalwareFile [-FileUri] [] +``` + +## DESCRIPTION + +The `Get-SPOMalwareFile` cmdlet runs on a single file. If the file is malware-infected then it returns an object of the type `SPOMalwareFile` which contains siteURL, filePath, malwareStatus flag, and malwareInfo (if applicable). You must be a SharePoint Online administrator to run the `Get-SPOMalwareFile` cmdlet. Note that this cmdlet does not work on files that are not malware-infected. + +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). + +## EXAMPLES + +### EXAMPLE 1 + +```powershell + Get-SPOMalwareFile -FileUri "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" +``` + +Example 1 returns an object of the type `SPOMalwareFile` which contains siteURL, filePath, malwareStatus flag, and malwareInfo (if applicable). + +## PARAMETERS + +### -FileUri + +Full URL for the file. + +```yaml +Type: System.Uri +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +The `Get-SPOMalwareFile` cmdlet returns an object of the type `SPOMalwareFile`. To get the file stream of the infected file, pass this object as a parameter to the `Get-SPOMalwareFileContent` cmdlet. + +## RELATED LINKS + +[Get-SPOMalwareFileContent](Get-SPOMalwareFileContent.md) + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMalwareFileContent.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMalwareFileContent.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md index 61b3441db..4bd4d7d37 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMalwareFileContent.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMalwareFileContent.md @@ -1,97 +1,110 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spomalwarefilecontent -applicable: SharePoint Online -title: Get-SPOMalwareFileContent -schema: 2.0.0 -author: vinandi -ms.author: vinandi -ms.reviewer: ---- - -# Get-SPOMalwareFileContent - -## SYNOPSIS - -Gets the file stream associated with the malware-infected file stored in SharePoint. - -## SYNTAX - -```powershell -Get-SPOMalwareFileContent -MalwareInfectedFile [] -``` - -## DESCRIPTION - -The `Get-SPOMalwareFileContent` cmdlet runs on a single file. If the file is malware-infected then it returns the file stream associated with it. You must be a SharePoint Online administrator to run the `Get-SPOMalwareFileContent` cmdlet. Note that this cmdlet does not work on files that are not malware-infected. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -$file = Get-SPOMalwareFile -FileUri "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" -Get-SPOMalwareFileContent -MalwareInfectedFile $file -``` - -Example 1 returns the file stream. - -### EXAMPLE 2 - -```powershell -Get-SPOMalwareFile -FileUri "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" | Get-SPOMalwareFileContent -``` - -Example 2 returns the file stream. - -### EXAMPLE 3 - -```powershell -$SPOFileUri = "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" - -$fileName = $SPOFileUri.split("/")[-1] -$localFolder = ".\$fileName" -$targetfile = New-Object IO.FileStream ($localFolder,[IO.FileMode]::Create) -[byte[]]$readbuffer = New-Object byte[] 1024 - -$file = Get-SPOMalwareFile -FileUri $SPOFileUri -$responseStream = Get-SPOMalwareFileContent -MalwareInfectedFile $file -do{ - $readlength = $responsestream.Read($readbuffer,0,1024) - $targetfile.Write($readbuffer,0,$readlength) -} -while ($readlength -ne 0) -$targetfile.close() -``` - -Example 3 downloads the file to the current working directory using the original filename. - -## PARAMETERS - -### -MalwareInfectedFile - -`SPOMalwareFile` object returned by `Get-SPOMalwareFile` cmdlet. - -```yaml -Type: SPOMalwareFile -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -``` - -## NOTES - -To get the `SPOMalwareFile` object, the user should execute the `Get-SPOMalwareFile` cmdlet first. Then that object can be used as a parameter to the `Get-SPOMalwareFileContentContent` cmdlet. - -## RELATED LINKS - -[Get-SPOMalwareFile](Get-SPOMalwareFile.md) - -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) +--- +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/get-spomalwarefilecontent +applicable: SharePoint Online +title: Get-SPOMalwareFileContent +schema: 2.0.0 +author: vinandi +ms.author: vinandi +ms.reviewer: +--- + +# Get-SPOMalwareFileContent + +## SYNOPSIS + +Gets the file stream associated with the malware-infected file stored in SharePoint. + +## SYNTAX + +``` +Get-SPOMalwareFileContent [-MalwareInfectedFile] [] +``` + +## DESCRIPTION + +The `Get-SPOMalwareFileContent` cmdlet runs on a single file. If the file is malware-infected then it returns the file stream associated with it. You must be a SharePoint Online administrator to run the `Get-SPOMalwareFileContent` cmdlet. Note that this cmdlet does not work on files that are not malware-infected. + +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +$file = Get-SPOMalwareFile -FileUri "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" +Get-SPOMalwareFileContent -MalwareInfectedFile $file +``` + +Example 1 returns the file stream. + +### EXAMPLE 2 + +```powershell +Get-SPOMalwareFile -FileUri "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" | Get-SPOMalwareFileContent +``` + +Example 2 returns the file stream. + +### EXAMPLE 3 + +```powershell +$SPOFileUri = "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" + +$fileName = $SPOFileUri.split("/")[-1] +$localFolder = ".\$fileName" +$targetfile = New-Object IO.FileStream ($localFolder,[IO.FileMode]::Create) +[byte[]]$readbuffer = New-Object byte[] 1024 + +$file = Get-SPOMalwareFile -FileUri $SPOFileUri +$responseStream = Get-SPOMalwareFileContent -MalwareInfectedFile $file +do{ + $readlength = $responsestream.Read($readbuffer,0,1024) + $targetfile.Write($readbuffer,0,$readlength) +} +while ($readlength -ne 0) +$targetfile.close() +``` + +Example 3 downloads the file to the current working directory using the original filename. + +## PARAMETERS + +### -MalwareInfectedFile + +`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 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.TenantAdministration.SPOMalwareFile + +## OUTPUTS + +### System.Object + +## NOTES + +To get the `SPOMalwareFile` object, the user should execute the `Get-SPOMalwareFile` cmdlet first. Then that object can be used as a parameter to the `Get-SPOMalwareFileContentContent` cmdlet. + +## RELATED LINKS + +[Get-SPOMalwareFile](Get-SPOMalwareFile.md) + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md index ae3910554..2bb3dcd55 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobProgress.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spomigrationjobprogress applicable: SharePoint Online @@ -14,27 +14,24 @@ ms.reviewer: ## SYNOPSIS -**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](https://learn.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets). +**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets). This cmdlet lets you report on SPO migration jobs that are in progress. ## SYNTAX ### AzureLocationsInline - -```powershell -Get-SPOMigrationJobProgress -AzureQueueUri -Credentials - [-DontWaitForEndJob] [-EncryptionParameters ] [-JobIds ] [-NoLogFile] - [-TargetWebUrl ] [] +``` +Get-SPOMigrationJobProgress [-TargetWebUrl ] -AzureQueueUri + -Credentials [-JobIds ] [-EncryptionParameters ] + [-DontWaitForEndJob] [-NoLogFile] [] ``` ### AzureLocationsImplicit - ``` -Get-SPOMigrationJobProgress -Credentials [-DontWaitForEndJob] - [-EncryptionParameters ] [-JobIds ] - -MigrationPackageAzureLocations [-NoLogFile] [-TargetWebUrl ] - [] +Get-SPOMigrationJobProgress [-TargetWebUrl ] -Credentials + -MigrationPackageAzureLocations [-JobIds ] + [-EncryptionParameters ] [-DontWaitForEndJob] [-NoLogFile] [] ``` ## DESCRIPTION @@ -43,7 +40,7 @@ This cmdlet lets you report on SPO migration jobs that are in progress. ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell $myQueueUri = @@ -53,7 +50,7 @@ Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri This will report on ALL jobs within the report queue. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell $jobIds = @(,....) @@ -63,7 +60,7 @@ Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri -JobIds $jobIds This will report only jobs defined within the $jobIds collection from the report queue. -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell $targetWebUrl = @@ -74,7 +71,7 @@ Get-SPOMigrationJobProgress - AzureQueueUri $myQueueUri - TargetWebUrl $targetWe This will report on any currently queued or in progress jobs and wait for all jobs to complete. -### -----------------------EXAMPLE 4----------------------------- +### EXAMPLE 4 ```powershell $targetWebUrl = @@ -92,7 +89,7 @@ This will report on any currently queued or in progress jobs and not wait for al An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import. ```yaml -Type: String +Type: System.String Parameter Sets: AzureLocationsInline Aliases: Applicable: SharePoint Online @@ -109,7 +106,7 @@ Accept wildcard characters: False 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: CredentialCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -126,7 +123,7 @@ Accept wildcard characters: False 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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -143,7 +140,7 @@ Accept wildcard characters: False An EncryptionParameters object. See New-SPOMigrationEncryptionParameters https://learn.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters for more information. ```yaml -Type: EncryptionParameters +Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -160,7 +157,7 @@ Accept wildcard characters: False Id of a previously created migration job that exists on the target site collection. ```yaml -Type: Guid[] +Type: System.Guid[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -177,7 +174,7 @@ Accept wildcard characters: False 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: MigrationPackageAzureLocations +Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: AzureLocationsImplicit Aliases: Applicable: SharePoint Online @@ -194,7 +191,7 @@ Accept wildcard characters: False 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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -211,7 +208,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md index 78e9dbaa8..abf282ea8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMigrationJobStatus.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spomigrationjobstatus applicable: SharePoint Online @@ -14,15 +14,15 @@ ms.reviewer: ## SYNOPSIS -**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](https://learn.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets). +**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets). Use this cmdlet to monitor the status of a submitted SharePoint Online migration job. ## SYNTAX -```powershell -Get-SPOMigrationJobStatus -Credentials [-JobId ] [-NoLogFile] - -TargetWebUrl [] +``` +Get-SPOMigrationJobStatus -TargetWebUrl [-JobId ] -Credentials + [-NoLogFile] [] ``` ## DESCRIPTION @@ -31,7 +31,7 @@ This cmdlet will check the status of a migration job. ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell $targetWebUrl = "https://contoso.sharepoint.com/sites/migrationtest" @@ -49,7 +49,7 @@ You can obtain the Job id when submit package data to create new SPO migration j 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: CredentialCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -66,7 +66,7 @@ Accept wildcard characters: False (optional) The ID of a migration job that exists on the target site collection. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -83,7 +83,7 @@ Accept wildcard characters: False (optional) Indicates to not create a log file. The default is to create a new DeleteMigrationJob log file within the current directory. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -100,7 +100,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -116,10 +116,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoCompanyAllowedDataLocation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMultiGeoCompanyAllowedDataLocation.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoCompanyAllowedDataLocation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMultiGeoCompanyAllowedDataLocation.md index 2c3212bc7..114808a90 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoCompanyAllowedDataLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMultiGeoCompanyAllowedDataLocation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spomultigeocompanyalloweddatalocation applicable: SharePoint Online @@ -18,7 +18,7 @@ Returns the SharePoint Online Multi geo allowed data locations. ## SYNTAX -```powershell +``` Get-SPOMultiGeoCompanyAllowedDataLocation [] ``` @@ -40,4 +40,14 @@ This example returns the SharePoint Online Multi geo allowed data locations. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoExperience.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMultiGeoExperience.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoExperience.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMultiGeoExperience.md index f17025426..d790e9245 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoExperience.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOMultiGeoExperience.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spomultigeoexperience applicable: SharePoint Online @@ -18,13 +18,13 @@ Use this cmdlet to get the multi geo experience mode. ## SYNTAX -```powershell +``` Get-SPOMultiGeoExperience [] ``` ## DESCRIPTION -Use this cmdlet to get the multi geo experience mode. For more information see [Enabling SharePoint Multi-Geo in your satellite geo location](https://learn.microsoft.com/office365/enterprise/enabling-sp-multigeo-satellite-geolocation) +Use this cmdlet to get the multi geo experience mode. For more information see [Enabling SharePoint Multi-Geo in your satellite geo location](/office365/enterprise/enabling-sp-multigeo-satellite-geolocation) ## EXAMPLES @@ -42,4 +42,14 @@ This example will show you whether the geo location is in SPO or ODB mode. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOOrgAssetsLibrary.md similarity index 64% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgAssetsLibrary.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOOrgAssetsLibrary.md index e64b02cd7..86c5662be 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOOrgAssetsLibrary.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spoorgassetslibrary applicable: SharePoint Online @@ -19,7 +19,7 @@ Displays information about all libraries designated as locations for organizatio ## SYNTAX -```powershell +``` Get-SPOOrgAssetsLibrary [] ``` @@ -41,16 +41,23 @@ Get-SPOOrgAssetsLibrary ## PARAMETERS +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Add-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/add-spoorgassetslibrary?view=sharepoint-ps) +[Add-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/add-spoorgassetslibrary) -[Set-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/set-spoorgassetslibrary?view=sharepoint-ps) +[Set-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/set-spoorgassetslibrary) -[Remove-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spoorgassetslibrary?view=sharepoint-ps) +[Remove-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/remove-spoorgassetslibrary) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOOrgNewsSite.md similarity index 94% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgNewsSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOOrgNewsSite.md index b0269b60f..b1f177fd8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgNewsSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOOrgNewsSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spoorgnewssite applicable: SharePoint Online @@ -17,7 +17,7 @@ Lists URLs of all the configured organizational news sites. Requires Tenant admi ## SYNTAX -```powershell +``` Get-SPOOrgNewsSite [] ``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPersonalSitePageCopyProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPersonalSitePageCopyProgress.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md index 6e3389fd1..752931ebd 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPersonalSitePageCopyProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPersonalSitePageCopyProgress.md @@ -1,112 +1,120 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spopersonalsitepagecopyprogress -applicable: SharePoint Online -title: Get-SPOPersonalSitePageCopyProgress -schema: 2.0.0 -author: xuyangzo -ms.author: xuyangzou -ms.reviewer: ---- - -# Get-SPOPersonalSitePageCopyProgress - -## SYNOPSIS - -This cmdlet enables you to track the progress of a SharePoint page's copy operation. - -## SYNTAX - -```powershell -Get-SPOPersonalSitePageCopyProgress -DestinationSite -WorkItemId [] -``` - -## DESCRIPTION - -After this cmdlet is executed, you'll receive the following information: - -| Property | Description | -| :------- | :---------- | -| ErrorMessage | The error message if there is an error. | -| JobState | The state of the job. | -| NewPageUrl | The URL of the new page if the copy is already finished. | -| SourcePageName | The name of the source page to copy. Will be empty. | -| StatusMessage | The message to describe the status. | -| WorkItemId | The work item id to track the status of the copy job if the copy job is in progress. | - -The following table explains the copy job's state: - -| Status | Explanation | -| :---------- | :---------- | -| Queued | The copy operation was queued for execution. | -| CreateAssetsFolderStart | We've started creating a folder to place all associated assets used on this page. | -| CreateAssetsFolderEnd | We've finished creating a folder to place all associated assets used on this page. | -| CopyAssetsStart | We've started copying associated assets used on this page. | -| CopyAssetsEnd | We've finished copying associated assets used on this page. | -| CreatePageStart | We've started creating a new page. | -| CreatePageEnd | We've finished creating a new page. | -| Succeeded | The copy operation was successful. | -| Deleting | The copy operation was deleted. | -| Failed | The copy operation failed. | -| JobNotFound | The copy operation wasn't found. | - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOPersonalSitePageCopyProgress -DestinationSite 'https://contoso.sharepoint.com/sites/testsite' -WorkItemId 1a95eb18-f68d-4dd4-9aaf-b47cf05cf02a -``` - -Example 1 shows how a SharePoint Administrator can check the status of a copy operation using a work item ID. - - -## PARAMETERS - -### -DestinationSite - -Specifies the URL of the destination SharePoint site to which the SharePoint page has been copied to. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkItemId - -Specifies the GUID of the work item created for the copy job if it is asynchronous. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) - -[Copy-SPOPersonalSitePage.md](./Copy-SPOPersonalSitePage.md) - -[Get-SPOSitePages.md](./Get-SPOSitePages.md) +--- +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/get-spopersonalsitepagecopyprogress +applicable: SharePoint Online +title: Get-SPOPersonalSitePageCopyProgress +schema: 2.0.0 +author: xuyangzo +ms.author: xuyangzou +ms.reviewer: +--- + +# Get-SPOPersonalSitePageCopyProgress + +## SYNOPSIS + +This cmdlet enables you to track the progress of a SharePoint page's copy operation. + +## SYNTAX + +``` +Get-SPOPersonalSitePageCopyProgress -DestinationSite -WorkItemId [] +``` + +## DESCRIPTION + +After this cmdlet is executed, you'll receive the following information: + +| Property | Description | +| :------- | :---------- | +| ErrorMessage | The error message if there is an error. | +| JobState | The state of the job. | +| NewPageUrl | The URL of the new page if the copy is already finished. | +| SourcePageName | The name of the source page to copy. Will be empty. | +| StatusMessage | The message to describe the status. | +| WorkItemId | The work item id to track the status of the copy job if the copy job is in progress. | + +The following table explains the copy job's state: + +| Status | Explanation | +| :---------- | :---------- | +| Queued | The copy operation was queued for execution. | +| CreateAssetsFolderStart | We've started creating a folder to place all associated assets used on this page. | +| CreateAssetsFolderEnd | We've finished creating a folder to place all associated assets used on this page. | +| CopyAssetsStart | We've started copying associated assets used on this page. | +| CopyAssetsEnd | We've finished copying associated assets used on this page. | +| CreatePageStart | We've started creating a new page. | +| CreatePageEnd | We've finished creating a new page. | +| Succeeded | The copy operation was successful. | +| Deleting | The copy operation was deleted. | +| Failed | The copy operation failed. | +| JobNotFound | The copy operation wasn't found. | + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-SPOPersonalSitePageCopyProgress -DestinationSite 'https://contoso.sharepoint.com/sites/testsite' -WorkItemId 1a95eb18-f68d-4dd4-9aaf-b47cf05cf02a +``` + +Example 1 shows how a SharePoint Administrator can check the status of a copy operation using a work item ID. + + +## PARAMETERS + +### -DestinationSite + +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 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WorkItemId + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Copy-SPOPersonalSitePage.md](./Copy-SPOPersonalSitePage.md) + +[Get-SPOSitePages.md](./Get-SPOSitePages.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPortalLaunchWaves.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPortalLaunchWaves.md new file mode 100644 index 000000000..20f6f3703 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPortalLaunchWaves.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOPortalLaunchWaves + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOPortalLaunchWaves [-LaunchSiteUrl ] [-DisplayFormat ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -DisplayFormat +{{ Fill DisplayFormat Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOPortalLaunchWavesConfiguration+WaveDisplayFormats +Parameter Sets: (All) +Aliases: +Accepted values: Raw, Formatted + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LaunchSiteUrl +{{ Fill LaunchSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPublicCdnOrigins.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPublicCdnOrigins.md index 1ba4bef69..8197a3f14 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOPublicCdnOrigins.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spopubliccdnorigins applicable: SharePoint Online @@ -18,7 +18,7 @@ This cmdlet returns a list of CDN Origins in your SharePoint Online Tenant ## SYNTAX -```powershell +``` Get-SPOPublicCdnOrigins [] ``` @@ -45,9 +45,19 @@ This example returns a list of CDN Origins. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedAccessForSitesInsights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedAccessForSitesInsights.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedAccessForSitesInsights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedAccessForSitesInsights.md index 582b08ad2..5dce0c53a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedAccessForSitesInsights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedAccessForSitesInsights.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-sporestrictedaccessforsitesinsights applicable: SharePoint Online @@ -20,7 +20,9 @@ This cmdlet enables the administrator to check status of all active and availabl ## SYNTAX ``` -Get-SPORestrictedAccessForSitesInsights [-RACProtectedSites] [-ActionsBlockedByPolicy] [-ReportId ] [-Action ] [-InsightsSummary] [-FullDetails] [-Content ] [] +Get-SPORestrictedAccessForSitesInsights [-RACProtectedSites] [-ActionsBlockedByPolicy] [-ReportId ] + [-Action ] [-InsightsSummary] [-FullDetails] [-Content ] + [] ``` ## DESCRIPTION @@ -34,7 +36,7 @@ If this cmdlet is executed with `-RACProtectedSites` `-ReportId` `-FullDetails` If this cmdlet is executed with `-RACProtectedSites` `-ReportId` `-InsightsSummary` as parameter, the count of sites protected with restricted access control compared to total number of sites will be displayed. If this cmdlet is executed with `-ActionsBlockedByPolicy` as parameter, it displays the status of all active and completed reports. - + If this cmdlet is executed with `-ActionsBlockedByPolicy` `-ReportId` `-Content TopSites` as parameter, top 100 sites with the highest access denials by restricted access control will be displayed. If this cmdlet is executed with `-ActionsBlockedByPolicy` `-ReportId` `-Content TopUsers` as parameter, top 10 users with the highest access denials by restricted access control will be displayed. @@ -48,7 +50,7 @@ If this cmdlet is executed with `-ActionsBlockedByPolicy` `-ReportId` `-Content ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPORestrictedAccessForSitesInsights -RACProtectedSites @@ -56,7 +58,7 @@ Get-SPORestrictedAccessForSitesInsights -RACProtectedSites Example 1 enables administrator to view the status of all active and completed reports on list of sites protected with restricted access control. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPORestrictedAccessForSitesInsights –RACProtectedSites -ReportId 9d946216-afe7-49f5-8267-7b662435c70b @@ -64,7 +66,7 @@ Get-SPORestrictedAccessForSitesInsights –RACProtectedSites -ReportId 9d946216- Example 2 enables administrator to view the report containing list of sites protected with restricted access control with ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Get-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy -ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Content TopSites @@ -79,7 +81,7 @@ Example 3 enables administrator to view the report containing top sites with acc It is an optional parameter, and it specifies whether to view or download a specific report. ```yaml -Type: ActionType +Type: Microsoft.Online.SharePoint.PowerShell.GetSPORestrictedAccessForSitesInsightsReport+ActionType Parameter Sets: (All) Aliases: Accepted values: View, Download @@ -96,7 +98,7 @@ Accept wildcard characters: False It is an optional parameter, and it specifies the type of report to be viewed or downloaded. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -112,7 +114,7 @@ Accept wildcard characters: False It is an optional parameter, and it specifies the subtype of the report to be viewed or downloaded. ```yaml -Type: SPOActionsBlockedByRACPolicyInsightType +Type: Microsoft.Online.SharePoint.PowerShell.SPOActionsBlockedByRACPolicyInsightType Parameter Sets: (All) Aliases: Accepted values: AllDenials, TopSites, TopUsers, SiteDistribution @@ -129,7 +131,7 @@ Accept wildcard characters: False It is an optional parameter and allows to download a CSV file containing up to 1 million records. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -145,7 +147,7 @@ Accept wildcard characters: False It is an optional parameter, and it specifies the subtype of the report to be viewed or downloaded. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -161,7 +163,7 @@ Accept wildcard characters: False It is an optional parameter, and it specifies the type of report to be viewed or downloaded. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -177,7 +179,7 @@ Accept wildcard characters: False It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -189,8 +191,17 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedContentDiscoverabilityReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedContentDiscoverabilityReport.md new file mode 100644 index 000000000..b04e1aa3a --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedContentDiscoverabilityReport.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPORestrictedContentDiscoverabilityReport + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPORestrictedContentDiscoverabilityReport [-ReportId ] [-Action ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Action +{{ Fill Action Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.GetSPORestrictedContentDiscoverabilityReport+ActionType +Parameter Sets: (All) +Aliases: +Accepted values: View, Download + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportId +{{ Fill ReportId Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedSiteCreation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreation.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedSiteCreation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreation.md index a4b614445..9cdf83da8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedSiteCreation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-sporestrictedsitecreation applicable: SharePoint Online @@ -18,8 +18,8 @@ This cmdlet allows SharePoint administrators to check the current configuration ## SYNTAX -```powershell -Get-SPORestrictedSiteCreation [-SiteType ] +``` +Get-SPORestrictedSiteCreation [-SiteType ] [] ``` ## DESCRIPTION @@ -53,15 +53,17 @@ Example 2 returns a comma-separated list of the IDs of the Microsoft Entra secur When provided, only return the Microsoft Entra security groups configured for the specified site type. PARAMVALUE: All | SharePoint | OneDrive | Team | Communication -- All - OneDrive and all SharePoint sites -- SharePoint - All SharePoint sites (but not OneDrive) -- OneDrive - Only OneDrive -- Team - Only SharePoint team sites (group-connected and classic) +- All - OneDrive and all SharePoint sites +- SharePoint - All SharePoint sites (but not OneDrive) +- OneDrive - Only OneDrive +- Team - Only SharePoint team sites (group-connected and classic) - Communication - Only SharePoint communication sites ```yaml -Type: RestrictedSiteCreationSiteType +Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCreationSiteType Parameter Sets: (All) +Aliases: +Accepted values: All, SharePoint, OneDrive, Team, Communication Applicable: SharePoint Online Required: False Position: Named @@ -70,6 +72,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOServicePrioritizationAppRegistrations.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOServicePrioritizationAppRegistrations.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOServicePrioritizationAppRegistrations.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOServicePrioritizationAppRegistrations.md index bd5259e65..d0a50a54f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOServicePrioritizationAppRegistrations.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOServicePrioritizationAppRegistrations.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Get-SPOServicePrioritizationAppRegistrations applicable: SharePoint Online @@ -37,7 +37,7 @@ This example retrieves all app registrations configured for service prioritizati ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -46,6 +46,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOServicePrioritizationBillingPolicies.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOServicePrioritizationBillingPolicies.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOServicePrioritizationBillingPolicies.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOServicePrioritizationBillingPolicies.md index 701880bf5..78df71bc8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOServicePrioritizationBillingPolicies.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOServicePrioritizationBillingPolicies.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Get-SPOServicePrioritizationBillingPolicies applicable: SharePoint Online @@ -37,7 +37,7 @@ This example retrieves all billing policies configured for service prioritizatio ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -46,6 +46,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index c5451e7ce..d30c90d8d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-sposite applicable: SharePoint Online @@ -18,25 +18,23 @@ Returns one or more site collections. ## SYNTAX -### ParamSet1 - -```powershell -Get-SPOSite [[-Identity] ] [-Detailed] [-Limit ] [] +### ParamSet1 (Default) ``` - -### ParamSet2 - -```powershell -Get-SPOSite [-Detailed] [-Filter ] [-IncludePersonalSite ] [-Limit ] - [-Template ] [-GroupIdDefined] [-ArchiveStatus ] [] +Get-SPOSite [[-Identity] ] [-Limit ] [-Detailed] [] ``` ### ParamSet3 - -```powershell +``` Get-SPOSite [-Identity] [-DisableSharingForNonOwnersStatus] [] ``` +### ParamSet2 +``` +Get-SPOSite [-Filter ] [-Limit ] [-Detailed] [-Template ] + [-IncludePersonalSite ] [-GroupIdDefined ] [-ArchiveStatus ] + [] +``` + ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets. @@ -56,7 +54,7 @@ The Detailed parameter has been deprecated. It will continue to work with earlie You need to be a SharePoint Online administrator and be a site collection administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). > [!NOTE] > If Site Collection Storage Management is enabled for the tenant, you will not be able to set quota and will have a generic error returned. To workaround this issue, set the site collection storage management to "manual" temporarily, set your quotas and then set the site collection storage management setting back to its original setting. @@ -67,7 +65,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOSite @@ -75,7 +73,7 @@ Get-SPOSite Example 1 returns all site collections. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOSite -Identity https://contoso.sharepoint.com @@ -83,7 +81,7 @@ Get-SPOSite -Identity https://contoso.sharepoint.com Example 2 lists the site collection with detailed properties. -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Get-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwnersStatus @@ -91,7 +89,7 @@ Get-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwners Example 3 Updates status on if the non owners of a site collection can share the site collection (does not set this value). -### -----------------------EXAMPLE 4----------------------------- +### EXAMPLE 4 ```powershell Get-SPOSite -Template GROUP#0 -IncludePersonalSite:$false @@ -99,7 +97,7 @@ Get-SPOSite -Template GROUP#0 -IncludePersonalSite:$false This example enumerates Group Site Collections in a tenant. -### -----------------------EXAMPLE 5----------------------------- +### EXAMPLE 5 ```powershell Get-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -detailed |fl @@ -107,7 +105,7 @@ Get-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -detailed | This example gets quota details for a Group Site. -### -----------------------EXAMPLE 6----------------------------- +### EXAMPLE 6 ```powershell Get-SPOSite -Identity https://contoso.sharepoint.com/sites/research | Select InformationSegment @@ -117,7 +115,7 @@ This example returns the InformationSegments associated with the site. It is app **Note**: This property is available only in SharePoint Online Management Shell Version 16.0.19927.12000 or later. -### -----------------------EXAMPLE 7----------------------------- +### EXAMPLE 7 ```powershell Get-SPOSite -Filter { Url -like "contoso.sharepoint.com/sites/18" } @@ -126,7 +124,7 @@ Get-SPOSite -Filter { Url -like "contoso.sharepoint.com/sites/18" } This example uses server side filtering to return sites matching 18. -### -----------------------EXAMPLE 8----------------------------- +### EXAMPLE 8 ```powershell Get-SPOSite -Limit ALL | ?{$_.IsTeamsConnected -eq $true} @@ -134,7 +132,7 @@ Get-SPOSite -Limit ALL | ?{$_.IsTeamsConnected -eq $true} This example uses client-side filtering to return a list of sites connected to Microsoft Teams. -### -----------------------EXAMPLE 9----------------------------- +### EXAMPLE 9 ```powershell Get-SPOSite -Limit ALL | ?{$_.IsTeamsChannelConnected -eq $true} @@ -143,7 +141,7 @@ Get-SPOSite -Limit ALL | ?{$_.IsTeamsChannelConnected -eq $true} This example uses client-side filtering to return a list of sites connected to a Microsoft Teams Private or Shared channel. -### -----------------------EXAMPLE 10----------------------------- +### EXAMPLE 10 ```powershell Get-SPOSite -Limit ALL -GroupIdDefined $true @@ -151,7 +149,7 @@ Get-SPOSite -Limit ALL -GroupIdDefined $true This example uses server-side filtering to return all sites that have an associated Microsoft 365 Group. -### -----------------------EXAMPLE 11----------------------------- +### EXAMPLE 11 ```powershell $userUPN="joe.healy@contoso.com" @@ -162,6 +160,24 @@ This example retrieves all sites filtering by the specified owner using a variab ## PARAMETERS +### -ArchiveStatus + +Displays sites of a specific archive status. For example, NotArchived, RecentlyArchived, FullyArchived, Archived, or Reactivating. + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.ArchiveStatusFilterType +Parameter Sets: ParamSet2 +Aliases: +Accepted values: NotArchived, FullyArchived, RecentlyArchived, Reactivating, Archived +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Detailed 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. @@ -169,19 +185,12 @@ Use this parameter to get additional property information on a site collection. The following properties are returned: - ResourceUsageCurrent - - ResourceUsageAverage - - StorageUsageCurrent - - LockIssue - - WebsCount - - CompatibilityLevel - - AllowSelfServiceUpgrade - - SiteDefinedSharingCapability Returns the stored value of the site policy. @@ -191,7 +200,7 @@ Returns the stored value of the site policy. Returns the effective access level, which is the site policy and the tenant policy combined. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet1, ParamSet2 Aliases: Applicable: SharePoint Online @@ -211,7 +220,7 @@ This parameter prevents non-owners from sharing. > This parameter is available only in SharePoint Online Management Shell Version 16.0.4613.1211 or later. DisableSharingForNonOwnersStatus is not a persisted setting but rather an analysis of the state of the site collection. The purpose of this is to get this setting, and it's not guaranteed that other settings returned are correct. To get other settings and values, use the Get-SPOSite without this parameter to ensure everything is displayed correctly. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet3 Aliases: Applicable: SharePoint Online @@ -229,10 +238,10 @@ Specifies the script block of the server-side filter to apply. The type must be 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. -Note: The operator values are case-sensitive. +Note: The operator values are case-sensitive. ```yaml -Type: String +Type: System.String Parameter Sets: ParamSet2 Aliases: Applicable: SharePoint Online @@ -244,31 +253,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity - -Specifies the URL of the site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludePersonalSite +### -GroupIdDefined -Displays personal sites when value is set to $true. +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 and $false. By default, the value is $false which means no personal sites will be returned. +The values are **$true**, **$false**, and **not defined**. By default, the value is **not defined**, which means that the filter does not apply. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet2 Aliases: Applicable: SharePoint Online @@ -280,29 +272,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Limit +### -Identity -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. +Specifies the URL of the site collection. ```yaml -Type: String -Parameter Sets: ParamSet1, ParamSet2 +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: ParamSet1, ParamSet3 Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Template +### -IncludePersonalSite -Displays sites of a specific template. For example, STS, STS#0, STS#1, STS#3, GROUP#0, SRCHCEN#0 or SITEPAGEPUBLISHING#0. +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. ```yaml -Type: String +Type: System.Boolean Parameter Sets: ParamSet2 Aliases: Applicable: SharePoint Online @@ -314,13 +308,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchiveStatus +### -Limit -Displays sites of a specific archive status. For example, NotArchived, RecentlyArchived, FullyArchived, Archived, or Reactivating. +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: String -Parameter Sets: ParamSet2 +Type: System.String +Parameter Sets: ParamSet1, ParamSet2 Aliases: Applicable: SharePoint Online @@ -331,14 +325,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GroupIdDefined - -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. +### -Template -The values are **$true**, **$false**, and **not defined**. By default, the value is **not defined**, which means that the filter does not apply. +Displays sites of a specific template. For example, STS, STS#0, STS#1, STS#3, GROUP#0, SRCHCEN#0 or SITEPAGEPUBLISHING#0. ```yaml -Type: Boolean +Type: System.String Parameter Sets: ParamSet2 Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteCollectionAppCatalogs.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteCollectionAppCatalogs.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteCollectionAppCatalogs.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteCollectionAppCatalogs.md index 7daa0a0a0..c1d9d7e28 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteCollectionAppCatalogs.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteCollectionAppCatalogs.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositecollectionappcatalogs applicable: SharePoint Online @@ -18,13 +18,13 @@ Use this cmdlet to get the Site Collection App Catalog. ## SYNTAX -```powershell - Get-SPOSiteCollectionAppCatalogs [-Site] [] +``` +Get-SPOSiteCollectionAppCatalogs [-Site] [] ``` ## DESCRIPTION -Use this cmdlet to get the Site Collection App Catalog. For more information, see [Use the App Catalog to make custom business apps available for your SharePoint environment](https://learn.microsoft.com/sharepoint/use-app-catalog) +Use this cmdlet to get the Site Collection App Catalog. For more information, see [Use the App Catalog to make custom business apps available for your SharePoint environment](/sharepoint/use-app-catalog) ## EXAMPLES @@ -43,12 +43,12 @@ This example returns the Site Collection App Catalog for the site [] ``` @@ -45,14 +45,14 @@ Verifies the encryption of the site https://contoso.sharepoint.com/sites/Researc The URL of the Site Collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False -Position: 1 +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -60,6 +60,10 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + ## OUTPUTS ### System.String @@ -78,10 +82,12 @@ The encryption status for the geo. Possible states include: * Registered: Customer Key encryption has been applied, and all files in all sites have been encrypted. * Rolling: A key roll is in progress. If your geo is in this state, you'll also be shown information on what percentage of sites have completed the key roll operation so that you can monitor progress. +## NOTES + ## RELATED LINKS -[Register-SPODataEncryptionPolicy](https://learn.microsoft.com/powershell/module/sharepoint-online/register-spodataencryptionpolicy) +[Register-SPODataEncryptionPolicy](/powershell/module/sharepoint-online/register-spodataencryptionpolicy) -[Controlling your data in Office 365 using Customer Key](https://learn.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) +[Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) -[Office 365: Setting up Customer Key for SharePoint Online and OneDrive for Business](https://learn.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key#office-365-setting-up-customer-key-for-sharepoint-online-and-onedrive-for-business) +[Office 365: Setting up Customer Key for SharePoint Online and OneDrive for Business](/microsoft-365/compliance/controlling-your-data-using-customer-key#office-365-setting-up-customer-key-for-sharepoint-online-and-onedrive-for-business) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesign.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesign.md index 969b5371f..b575a4d85 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesign.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositedesign applicable: SharePoint Online @@ -18,7 +18,7 @@ Gets details about site designs that are on the SharePoint tenant. You can speci ## SYNTAX -```powershell +``` Get-SPOSiteDesign [[-Identity] ] [] ``` @@ -50,13 +50,28 @@ Description : Use this design to apply Contoso theme and create The ID of the site design to retrieve. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRights.md similarity index 63% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRights.md index 102b115a3..5ee74a949 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRights.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositedesignrights applicable: SharePoint Online @@ -18,8 +18,8 @@ Displays a list of principals and their rights for usage of the site design. Thi ## SYNTAX -```powershell -Get-SPOSiteDesignRights [-Identity] [] +``` +Get-SPOSiteDesignRights [-Identity] [] ``` ## DESCRIPTION @@ -47,13 +47,28 @@ Nestor Wilke i:0#.f|membership|nestorw@contoso.onmicrosoft.com View The ID of the site design to get scoping information. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRun.md similarity index 91% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRun.md index 056a45370..79045bbe0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRun.md @@ -18,7 +18,7 @@ Retrieves a list of site designs applied to a specified site collection. ## SYNTAX -```powershell +``` Get-SPOSiteDesignRun [-WebUrl] [[-SiteDesignId] ] [] ``` @@ -28,7 +28,7 @@ Retrieves a list of site designs applied to a specified site collection. The Web ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 This example would return a list of the site designs applied to the specified site. Providing a specific site design ID will return the details for just that applied site design. @@ -50,7 +50,7 @@ SiteDesignTitle: | Contoso Project Playbook The ID of a specific site design. Use this optional parameter if you wish to only return details on a specific site design run. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: @@ -66,7 +66,7 @@ Accept wildcard characters: False The Url of the site collection. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -78,9 +78,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRunStatus.md similarity index 93% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRunStatus.md index e9d3adb5a..5dc3e7d17 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignRunStatus.md @@ -18,7 +18,7 @@ Retrieves and displays a list of all site script actions executed for a specifie ## SYNTAX -```powershell +``` Get-SPOSiteDesignRunStatus [-Run] [] ``` @@ -65,7 +65,7 @@ OutcomeText: | The site design run for the desired set of script action details. ```yaml -Type: SPOSiteDesignRun +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignRun Parameter Sets: (All) Aliases: @@ -77,9 +77,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignTask.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignTask.md index 94133fd7d..6d0961ba9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteDesignTask.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositedesigntask applicable: SharePoint Online @@ -18,8 +18,8 @@ Cmdlet to get a scheduled site design script. ## SYNTAX -```powershell -Get-SPOSiteDesignTask -Identity -WebUrl [] +``` +Get-SPOSiteDesignTask [[-Identity] ] [[-WebUrl] ] [] ``` ## DESCRIPTION @@ -31,13 +31,13 @@ Used to retrieve a scheduled site design script. It takes the ID of the schedule ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectawesome" ``` -This example returns a scheduled site design whose ID is 501z8c32-4147-44d4-8607-26c2f67cae82 and which was applied on the site . +This example returns a scheduled site design whose ID is 501z8c32-4147-44d4-8607-26c2f67cae82 and which was applied on the site . ## PARAMETERS @@ -46,14 +46,14 @@ This example returns a scheduled site design whose ID is 501z8c32-4147-44d4-8607 The ID of the scheduled site design to apply. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: Named +Required: False +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -62,12 +62,12 @@ Accept wildcard characters: False The URL of the site collection where the site design will be applied. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -77,6 +77,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Add-SPOSiteDesignTask](Add-SPOSiteDesignTask.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteFileVersionBatchDeleteJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionBatchDeleteJobProgress.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteFileVersionBatchDeleteJobProgress.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionBatchDeleteJobProgress.md index 1f83d7063..fd0162ab7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteFileVersionBatchDeleteJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionBatchDeleteJobProgress.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositefileversionbatchdeletejobprogress applicable: SharePoint Online @@ -19,7 +19,7 @@ Gets the progress of a trim job for a site collection. ## SYNTAX -```powershell +``` Get-SPOSiteFileVersionBatchDeleteJobProgress [-Identity] [] ``` @@ -44,12 +44,12 @@ Example 1 gets the progress of a trim job for a site collection. Specifies the URL of the site collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False @@ -59,6 +59,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Remove-SPOSiteFileVersionBatchDeleteJob](Remove-SPOSiteFileVersionBatchDeleteJob.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteFileVersionExpirationReportJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionExpirationReportJobProgress.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteFileVersionExpirationReportJobProgress.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionExpirationReportJobProgress.md index 140b88394..8750b4053 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteFileVersionExpirationReportJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteFileVersionExpirationReportJobProgress.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositefileversionexpirationreportjobprogress applicable: SharePoint Online @@ -19,8 +19,9 @@ Gets the status for a file version expiration report generation job for a site c ## SYNTAX -```powershell -Get-SPOSiteFileVersionExpirationReportJobProgress [-Identity] [-ReportUrl ] [] +``` +Get-SPOSiteFileVersionExpirationReportJobProgress [-Identity] -ReportUrl + [] ``` ## DESCRIPTION @@ -44,12 +45,12 @@ Example 1 gets the status for a file version expiration report generation job fo Specifies the URL of the site collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False @@ -60,8 +61,9 @@ Accept wildcard characters: False The URL of the report to get the job status on. ```yaml -Type: string +Type: System.String Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -74,6 +76,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [New-SPOSiteFileVersionExpirationReportJob](New-SPOSiteFileVersionExpirationReportJob.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md index 28ab1fda0..6fa409d9b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteGroup.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositegroup applicable: SharePoint Online @@ -18,8 +18,8 @@ Gets all the groups on the specified site collection. ## SYNTAX -```powershell -Get-SPOSiteGroup [-Group ] [-Limit ] -Site [] +``` +Get-SPOSiteGroup -Site [-Group ] [-Limit ] [] ``` ## DESCRIPTION @@ -28,11 +28,11 @@ Use the `Get-SPOSiteGroup` cmdlet to get all the groups on the specified site co You must be a SharePoint Online administrator and a site collection administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [SharePoint Online PowerShell](https://learn.microsoft.com/powershell/module/sharepoint-online/index). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [SharePoint Online PowerShell](/powershell/module/sharepoint-online/index). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA @@ -47,7 +47,7 @@ This example returns all the groups on the specified site collection [] -``` - -## DESCRIPTION - -After this cmdlet is executed, the information for each SharePoint page will be displayed with the following properties: - -| Property | Description | -| :------------------- | :--------------------------------------- | -| Name | The name of the SharePoint page. | -| Title | The title of the SharePoint page. | -| UniqueId | The unique ID of the SharePoint page. | -| CreatedDateTime | The creation date and time of the SharePoint page. | -| LastModifiedDateTime | The last modified date and time of the SharePoint page. | -| CreatedBy | The creator of the SharePoint page. | - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOSitePages -Site 'https://contoso.sharepoint.com/sites/testsite' -``` - -Example 1 demonstrates how a SharePoint Administrator can retrieve all the SharePoint pages under the `testsite`. - - -## PARAMETERS - -### -Site - -Specifies the URL of the SharePoint site from which to fetch the SharePoint pages. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) - -[Copy-SPOPersonalSitePage.md](./Copy-SPOPersonalSitePage.md) - -[Get-SPOPersonalSitePageCopyProgress.md](./Get-SPOPersonalSitePageCopyProgress.md) +--- +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/get-spositepages +applicable: SharePoint Online +title: Get-SPOSitePages +schema: 2.0.0 +author: xuyangzo +ms.author: xuyangzou +ms.reviewer: +--- + +# Get-SPOSitePages + +## SYNOPSIS + +This cmdlet allows you to retrieve all SharePoint pages under a specific SharePoint site. + +## SYNTAX + +``` +Get-SPOSitePages -Site [] +``` + +## DESCRIPTION + +After this cmdlet is executed, the information for each SharePoint page will be displayed with the following properties: + +| Property | Description | +| :------------------- | :--------------------------------------- | +| Name | The name of the SharePoint page. | +| Title | The title of the SharePoint page. | +| UniqueId | The unique ID of the SharePoint page. | +| CreatedDateTime | The creation date and time of the SharePoint page. | +| LastModifiedDateTime | The last modified date and time of the SharePoint page. | +| CreatedBy | The creator of the SharePoint page. | + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Get-SPOSitePages -Site 'https://contoso.sharepoint.com/sites/testsite' +``` + +Example 1 demonstrates how a SharePoint Administrator can retrieve all the SharePoint pages under the `testsite`. + + +## PARAMETERS + +### -Site + +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 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Copy-SPOPersonalSitePage.md](./Copy-SPOPersonalSitePage.md) + +[Get-SPOPersonalSitePageCopyProgress.md](./Get-SPOPersonalSitePageCopyProgress.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteRenameState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteRenameState.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteRenameState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteRenameState.md index a164daf13..6a0f72d5c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteRenameState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteRenameState.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositerenamestate applicable: SharePoint Online @@ -18,21 +18,19 @@ Returns the current rename job state of a SharePoint Online Site. ## SYNTAX -### SourceSiteUrl - -```powershell +### SourceSiteUrl (Default) +``` Get-SPOSiteRenameState -Identity [-WhatIf] [-Confirm] [] ``` ### ParentId - -```powershell -Get-SPOSiteRenameState -ParentOperationId [-State ] [-WhatIf] [-Confirm] [] +``` +Get-SPOSiteRenameState -ParentOperationId [-State ] [-WhatIf] [-Confirm] + [] ``` ### RenameReport - -```powershell +``` Get-SPOSiteRenameState [-State ] [-WhatIf] [-Confirm] [] ``` @@ -74,7 +72,7 @@ This example returns rename jobs that were initiated by a tenant rename. The urls of the site to be renamed. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: SourceSiteUrl Aliases: Applicable: SharePoint Online @@ -90,7 +88,7 @@ Accept wildcard characters: False The parent operation id that initiated the site to be renamed. For example, the tenant rename job id. ```yaml -Type: guid +Type: System.Guid Parameter Sets: ParentId Aliases: Applicable: SharePoint Online @@ -106,19 +104,16 @@ Accept wildcard characters: False The state of the rename job, possible values are - Queued - - InProgress - - Success - - Failed - - Suspended ```yaml -Type: RenameState -Parameter Sets: RenameReport, ParentId +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 @@ -133,7 +128,7 @@ Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -150,7 +145,7 @@ Displays a message that describes the effect of the command instead of executing For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -165,4 +160,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteReview.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteReview.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteReview.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteReview.md index 5c99c52ff..2a2ec3de7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteReview.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteReview.md @@ -1,5 +1,5 @@ ---- -external help file: sharepointonline.xml +--- +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/get-spositereview applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Get-SPOSiteReview schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -19,7 +19,8 @@ Track all site access reviews initiated from Data Access Governance (DAG) report ## SYNTAX ``` -Get-SPOSiteReview [-SiteReviewID ] [-Status ] [-ReportEntity ] [-SiteID ] [] +Get-SPOSiteReview [-SiteReviewID ] [-Status ] + [-ReportEntity ] [-SiteID ] [] ``` ## DESCRIPTION @@ -40,10 +41,10 @@ The above cmdlet retrieves all site access reviews raised under all 'Permissione Specifies the entity that could cause oversharing and hence tracked by these reports. ```yaml -Type: SiteAccessReportEntityEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.SiteAccessReportEntityEnum Parameter Sets: (All) Aliases: -Accepted values: All, SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers, PermissionsReport +Accepted values: All, SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers Required: False Position: Named @@ -71,7 +72,7 @@ Accept wildcard characters: False Specifies the ID of the particular access review. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -86,7 +87,7 @@ Accept wildcard characters: False Specifies the current status of the site access review. ```yaml -Type: SiteReviewStatus +Type: Microsoft.Online.SharePoint.TenantAdministration.SiteReviewStatus Parameter Sets: (All) Aliases: Accepted values: All, Pending, Failed, Completed @@ -99,7 +100,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScript.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScript.md index 2e70d2437..8a18b0f7c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScript.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositescript applicable: SharePoint Online @@ -18,7 +18,7 @@ Displays information about existing site scripts. ## SYNTAX -```powershell +``` Get-SPOSiteScript [[-Identity] ] [] ``` @@ -59,17 +59,28 @@ Version : 1 The ID of the site script to get information about. ```yaml -Type: SPOSiteScriptPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromList.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromList.md index f67ed32b6..9112ecdee 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromList.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositescriptfromlist applicable: SharePoint Online @@ -18,8 +18,8 @@ Creates site script syntax from an existing SharePoint list. ## SYNTAX -```powershell -Get-SPOSiteScriptFromList -ListUrl [] +``` +Get-SPOSiteScriptFromList [-ListUrl] [] ``` ## DESCRIPTION @@ -52,12 +52,23 @@ Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromWeb.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromWeb.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromWeb.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromWeb.md index a9d5df5a9..e8b28989a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromWeb.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptFromWeb.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositescriptfromweb applicable: SharePoint Online @@ -18,8 +18,10 @@ Creates site script syntax from an existing SharePoint site. ## SYNTAX -```powershell -Get-SPOSiteScriptFromWeb [-WebUrl] [-IncludedLists ] [-IncludeBranding] [-IncludeTheme] [-IncludeRegionalSettings] [-IncludeSiteExternalSharingCapability] [-IncludeLinksToExportedItems] [] +``` +Get-SPOSiteScriptFromWeb [-WebUrl] [-IncludedLists ] [-IncludeBranding] [-IncludeTheme] + [-IncludeRegionalSettings] [-IncludeSiteExternalSharingCapability] [-IncludeLinksToExportedItems] + [] ``` ## DESCRIPTION @@ -49,16 +51,16 @@ C:\> Add-SPOSiteScript ` ## PARAMETERS -### -WebUrl +### -IncludeBranding -The url that starts with HTTPS of the site to retrieve the site script. +A switch that if provided, extracts the configuration of the site's branding. ```yaml -Type: string +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -72,7 +74,7 @@ An array of one or more lists. Each is identified by the list url. Note: Currently, navigation nodes are not exported. ```yaml -Type: string[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -83,12 +85,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeBranding +### -IncludeLinksToExportedItems -A switch that if provided, extracts the configuration of the site's branding. +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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -99,12 +101,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeTheme +### -IncludeRegionalSettings -A switch that if provided, extracts the site's custom theme by using the themeJson property. +A switch that if provided, extracts the site's regional settings. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -115,12 +117,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRegionalSettings +### -IncludeSiteExternalSharingCapability -A switch that if provided, extracts the site's regional settings. +A switch that if provided, extracts the site's external sharing capability. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -131,12 +133,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSiteExternalSharingCapability +### -IncludeTheme -A switch that if provided, extracts the site's external sharing capability. +A switch that if provided, extracts the site's custom theme by using the themeJson property. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -147,16 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeLinksToExportedItems +### -WebUrl -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. +The url that starts with HTTPS of the site to retrieve the site script. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -164,5 +166,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFile.md new file mode 100644 index 000000000..d027bba21 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFile.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOSiteScriptPackageFile + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOSiteScriptPackageFile [-Identity] -OutputFilePath [-Overwrite] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OutputFilePath +{{ Fill OutputFilePath Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +{{ Fill Overwrite Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFromWeb.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFromWeb.md new file mode 100644 index 000000000..f104b5fa3 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteScriptPackageFromWeb.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOSiteScriptPackageFromWeb + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOSiteScriptPackageFromWeb [-WebUrl] -OutputFilePath [-IncludedLists ] + [-IncludeBranding] [-IncludeTheme] [-IncludeRegionalSettings] [-IncludeSiteExternalSharingCapability] + [-IncludeLinksToExportedItems] [-IncludedPages ] [-Overwrite] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -IncludeBranding +{{ Fill IncludeBranding Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedLists +{{ Fill IncludedLists Description }} + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludedPages +{{ Fill IncludedPages Description }} + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeLinksToExportedItems +{{ Fill IncludeLinksToExportedItems Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeRegionalSettings +{{ Fill IncludeRegionalSettings Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSiteExternalSharingCapability +{{ Fill IncludeSiteExternalSharingCapability Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTheme +{{ Fill IncludeTheme Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFilePath +{{ Fill OutputFilePath Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Overwrite +{{ Fill Overwrite Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebUrl +{{ Fill WebUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteUserInvitations.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteUserInvitations.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteUserInvitations.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteUserInvitations.md index 206eb46e6..f99c44f55 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteUserInvitations.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteUserInvitations.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositeuserinvitations applicable: SharePoint Online @@ -14,17 +14,17 @@ ms.reviewer: ## SYNOPSIS -Searches against all stored sharing links and retrieves the email invites. +Searches against all stored sharing links and retrieves the email invites. ## SYNTAX -```powershell -Get-SPOSiteUserInvitations [-Site] [-EmailAddress] [] +``` +Get-SPOSiteUserInvitations [-Site] [-EmailAddress] [] ``` ## DESCRIPTION -Searches against all stored sharing links on a Site and retrieves the email invites. +Searches against all stored sharing links on a Site and retrieves the email invites. ## EXAMPLES @@ -38,40 +38,49 @@ This example retrieves email invites stored in the ContosoWeb1 site to the user ## PARAMETERS -### -Site +### -EmailAddress -Specifies the URL of the site collection. +Email Address of the user. ```yaml -Type: SpoSitePipeBind +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EmailAddress +### -Site -Email Address of the user. +Specifies the URL of the site collection. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteVersionPolicyJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteVersionPolicyJobProgress.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteVersionPolicyJobProgress.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteVersionPolicyJobProgress.md index 9f5b8f5b8..fb9d6f6ef 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteVersionPolicyJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSiteVersionPolicyJobProgress.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spositeversionpolicyjobprogress applicable: SharePoint Online @@ -43,12 +43,12 @@ Example 1 gets the progress of setting version policy for existing document libr Specifies the URL of the site collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False @@ -58,6 +58,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Set-SPOSite](Set-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStorageEntity.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStorageEntity.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStorageEntity.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStorageEntity.md index 00064d174..d0af6c14e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStorageEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStorageEntity.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spostorageentity applicable: SharePoint Online @@ -19,8 +19,8 @@ This cmdlet is used to get a value in the property bag. ## SYNTAX -```powershell -Get-SPOStorageEntity [-Site] [-Key] [] +``` +Get-SPOStorageEntity [-Site] [-Key] [] ``` ## DESCRIPTION @@ -39,33 +39,33 @@ This example returns the whole entry in the property bag. ## PARAMETERS -### -Site +### -Key -URL to the tenant or site collection app catalog. +The key in the property bag that should be returned. ```yaml -Type: SpoSitePipeBind +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Key +### -Site -The key in the property bag that should be returned. +URL to the tenant or site collection app catalog. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 2 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -75,4 +75,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md similarity index 76% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheSiteState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md index 9dddc6668..b78c66d7e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheSiteState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheSiteState.md @@ -23,24 +23,24 @@ Get-SPOStructuralNavigationCacheSiteState -SiteUrl [] ``` ## DESCRIPTION -The Get-SPOStructuralNavigationCacheSiteState cmdlet can be used to determine if structural navigation caching is enabled or disabled for a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). +The Get-SPOStructuralNavigationCacheSiteState cmdlet can be used to determine if structural navigation caching is enabled or disabled for a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). ## EXAMPLES ### Example 1 ```powershell -PS C:\> Get-SPOStructuralNavigationCacheSiteState -SiteUrl "https://contoso.sharepoint.com/sites/product/" +PS C:\> Get-SPOStructuralNavigationCacheSiteState -SiteUrl "https://contoso.sharepoint.com/sites/product/" ``` -This example checks if structural navigation caching is enabled for the entire site collection https://contoso.sharepoint.com/sites/product/. If caching is enabled, then it will return True. If caching is disabled, then it will return False. +This example checks if structural navigation caching is enabled for the entire site collection https://contoso.sharepoint.com/sites/product/. If caching is enabled, then it will return True. If caching is disabled, then it will return False. ## PARAMETERS ### -SiteUrl -Specifies the absolute URL for the site collection's root web being checked for its caching state. +Specifies the absolute URL for the site collection's root web being checked for its caching state. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -52,7 +52,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -61,17 +61,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES - To see the examples, type: "get-help Get-SPOStructuralNavigationCacheSiteState -examples". - For more information, type: "get-help Get-SPOStructuralNavigationCacheSiteState -detailed". +To see the examples, type: "get-help Get-SPOStructuralNavigationCacheSiteState -examples". + +For more information, type: "get-help Get-SPOStructuralNavigationCacheSiteState -detailed". - For technical information, type: "get-help Get-SPOStructuralNavigationCacheSiteState -full". +For technical information, type: "get-help Get-SPOStructuralNavigationCacheSiteState -full". + +For online help, type: "get-help Get-SPOStructuralNavigationCacheSiteState -online" - For online help, type: "get-help Get-SPOStructuralNavigationCacheSiteState -online" - ## RELATED LINKS + [Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) [Set-SPOStructuralNavigationCacheWebState](Set-SPOStructuralNavigationCacheWebState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheWebState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheWebState.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheWebState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheWebState.md index 7ce7fcc87..eb6106594 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheWebState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOStructuralNavigationCacheWebState.md @@ -14,7 +14,7 @@ ms.reviewer: # Get-SPOStructuralNavigationCacheWebState ## SYNOPSIS -Get the structural navigation caching state for a web. +Get the structural navigation caching state for a web. ## SYNTAX @@ -23,13 +23,13 @@ Get-SPOStructuralNavigationCacheWebState -WebUrl [] ``` ## DESCRIPTION -The Get-SPOStructuralNavigationCacheWebState cmdlet can be used to determine if structural navigation caching is enabled or disabled for a web in a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). +The Get-SPOStructuralNavigationCacheWebState cmdlet can be used to determine if structural navigation caching is enabled or disabled for a web in a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). ## EXAMPLES ### Example 1 ```powershell -PS C:\> Get-SPOStructuralNavigationCacheWebState -weburl "https://contoso.sharepoint.com/sites/product/electronics" +PS C:\> Get-SPOStructuralNavigationCacheWebState -weburl "https://contoso.sharepoint.com/sites/product/electronics" ``` This example checks if structural navigation caching is enabled for the web https://contoso.sharepoint.com/sites/product/electronics. If caching is enabled, then it will return True. If caching is disabled, then it will return False. @@ -40,7 +40,7 @@ This example checks if structural navigation caching is enabled for the web http Specifies the absolute URL for the web being checked for its caching state. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -52,7 +52,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -61,15 +61,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES - To see the examples, type: "get-help Get-SPOStructuralNavigationCacheWebState -examples". - For more information, type: "get-help Get-SPOStructuralNavigationCacheWebState -detailed". +To see the examples, type: "get-help Get-SPOStructuralNavigationCacheWebState -examples". + +For more information, type: "get-help Get-SPOStructuralNavigationCacheWebState -detailed". - For technical information, type: "get-help Get-SPOStructuralNavigationCacheWebState -full". +For technical information, type: "get-help Get-SPOStructuralNavigationCacheWebState -full". + +For online help, type: "get-help Get-SPOStructuralNavigationCacheWebState -online" - For online help, type: "get-help Get-SPOStructuralNavigationCacheWebState -online" ## RELATED LINKS + [Set-SPOStructuralNavigationCacheWebState](Set-SPOStructuralNavigationCacheWebState.md) [Get-SPOStructuralNavigationCacheSiteState](Get-SPOStructuralNavigationCacheSiteState.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTemporarilyDisableAppBar.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTemporarilyDisableAppBar.md new file mode 100644 index 000000000..b6a742239 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTemporarilyDisableAppBar.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOTemporarilyDisableAppBar + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOTemporarilyDisableAppBar [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenant.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenant.md index a6c23992c..014efe104 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenant.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenant applicable: SharePoint Online @@ -18,8 +18,8 @@ Returns SharePoint Online organization properties. ## SYNTAX -```powershell -Get-SPOTenant [] +``` +Get-SPOTenant [-ShowDetails] [] ``` ## DESCRIPTION @@ -30,11 +30,11 @@ Currently, there are no parameters for this cmdlet. You must be a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Get-SPOTenant @@ -44,6 +44,21 @@ This example returns the organization-level site collection properties such as S ## PARAMETERS +### -ShowDetails +{{ Fill ShowDetails Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -56,6 +71,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md index ad26d2ede..002e44a29 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnEnabled.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantcdnenabled applicable: SharePoint Online @@ -18,7 +18,7 @@ Returns whether Public content delivery network (CDN) or Private CDN is enabled ## SYNTAX -```powershell +``` Get-SPOTenantCdnEnabled -CdnType [] ``` @@ -28,7 +28,7 @@ Returns whether Public content delivery network (CDN) or Private CDN is enabled ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOTenantCdnEnabled -CdnType Public @@ -43,7 +43,7 @@ The example returns a CDN with a type of public. Specifies the CDN type. The valid values are Public or Private. ```yaml -Type: SPOTenantCdnType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md index 71ad6b356..e2b775e3d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnOrigins.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantcdnorigins applicable: SharePoint Online @@ -18,7 +18,7 @@ Lists all the configured origins under the tenancy or under a given site. You mu ## SYNTAX -```powershell +``` Get-SPOTenantCdnOrigins -CdnType [] ``` @@ -28,7 +28,7 @@ Lists all the configured origins under the tenancy or under a given site. ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOTenantCdnOrigins -CdnType Public @@ -43,7 +43,7 @@ The example returns a list of origins from the Tenant. Specifies the CDN type. The valid values are: Public or Private. ```yaml -Type: SPOTenantCdnType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md index 4c9aaa728..b46937279 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantCdnPolicies.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantcdnpolicies applicable: SharePoint Online @@ -18,7 +18,7 @@ Get the public or private Policies applied on your SharePoint Online Tenant. Req ## SYNTAX -```powershell +``` Get-SPOTenantCdnPolicies -CdnType [] ``` @@ -51,7 +51,7 @@ This example returns private CDN policies of your tenant. Type of CDN on the current SPO Tenant (Public,Private) ```yaml -Type: SPOTenantCdnType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private @@ -68,9 +68,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantContentTypeReplicationParameters.md similarity index 93% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantContentTypeReplicationParameters.md index 81242c254..88908b8ac 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantContentTypeReplicationParameters.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantcontenttypereplicationparameters applicable: SharePoint Online @@ -18,7 +18,7 @@ Gets content types for replication parameters ## SYNTAX -```powershell +``` Get-SPOTenantContentTypeReplicationParameters [] ``` @@ -43,6 +43,16 @@ Gets content types for replication parameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingGroup.md new file mode 100644 index 000000000..bfd9949be --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingGroup.md @@ -0,0 +1,78 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOTenantIdentityMappingGroup + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOTenantIdentityMappingGroup [-Field] [-Value] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Field +{{ Fill Field Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.TenantIdentityMappingGroupField +Parameter Sets: (All) +Aliases: +Accepted values: SourceGroupObjectId, TargetGroupObjectId, TargetGroupName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +{{ Fill Value Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingUser.md new file mode 100644 index 000000000..dd4bf7027 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantIdentityMappingUser.md @@ -0,0 +1,78 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOTenantIdentityMappingUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOTenantIdentityMappingUser [-Field] [-Value] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Field +{{ Fill Field Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.TenantIdentityMappingUserField +Parameter Sets: (All) +Aliases: +Accepted values: SourceUserKey, TargetUserPuid, TargetUserUpn, TargetUserEmail + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +{{ Fill Value Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md index 6cb8c9c1b..211079ace 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogEntry.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantlogentry applicable: SharePoint Online @@ -18,25 +18,28 @@ Retrieves SharePoint Online company logs. This cmdlet is reserved for internal M ## SYNTAX -### CorrelationId - -```powershell +### SiteSubscriptionId (Default) +``` Get-SPOTenantLogEntry [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] [[-MaxRows] ] - -CorrelationId [] + [] ``` -### Source +### CorrelationId +``` +Get-SPOTenantLogEntry -CorrelationId [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] + [[-MaxRows] ] [] +``` -```powershell -Get-SPOTenantLogEntry [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] [[-MaxRows] ] - -Source [] +### Source +``` +Get-SPOTenantLogEntry -Source [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] + [[-MaxRows] ] [] ``` ### User - -```powershell -Get-SPOTenantLogEntry [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] [[-MaxRows] ] - -User [] +``` +Get-SPOTenantLogEntry -User [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] + [[-MaxRows] ] [] ``` ## DESCRIPTION @@ -48,15 +51,15 @@ The `Get-SPOTenantLogEntry` cmdlet cannot retrieve all SharePoint Online errors. For Beta 2, the only company logs available are for Business Connectivity Services (BCS). > [!NOTE] -> If you do not use any parameter, the first 1000 rows in descending time range are returned. +> If you do not use any parameter, the first 1000 rows in descending time range are returned. You must be at least a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOTenantLogEntry @@ -64,7 +67,7 @@ Get-SPOTenantLogEntry This example retrieves all logs that are available. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOTenantLogEntry -MaxRows 500 @@ -72,7 +75,7 @@ Get-SPOTenantLogEntry -MaxRows 500 This example retrieves the first 500 log entries. -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell $endTimeinUTC = Get-SPOTenantLogLastAvailableTimeInUtc @@ -82,7 +85,7 @@ $tenantlogs = Get-SPOTenantLogEntry -StartTimeinUtc $startTimeinUTC -EndTimeinUT This example retrieves log entries recorded over that previous 14 days. -### -----------------------EXAMPLE 4----------------------------- +### EXAMPLE 4 ```powershell $endTimeinUTC = Get-SPOTenantLogLastAvailableTimeInUtc @@ -99,7 +102,7 @@ This example retrieves log entries recorded over that previous 14 days that have Specifies the Correlation ID as a filter. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: CorrelationId Aliases: Applicable: SharePoint Online @@ -116,7 +119,7 @@ Accept wildcard characters: False Specifies the end time in UTC to search for logs. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -133,7 +136,7 @@ Accept wildcard characters: False 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: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -150,7 +153,7 @@ Accept wildcard characters: False Specifies the component that logs the errors. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: Source Aliases: Applicable: SharePoint Online @@ -167,7 +170,7 @@ Accept wildcard characters: False Specifies the start time in Coordinated Universal Time (UTC) to search for the logs (for example, 01032011:12:00). ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -184,7 +187,7 @@ Accept wildcard characters: False Specifies the log-on identity as a filter. ```yaml -Type: String +Type: System.String Parameter Sets: User Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogLastAvailableTimeInUtc.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogLastAvailableTimeInUtc.md index 5b770a87a..349a31479 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantLogLastAvailableTimeInUtc.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantloglastavailabletimeinutc applicable: SharePoint Online @@ -18,7 +18,7 @@ Returns the most recent time when the SharePoint Online organization logs were c ## SYNTAX -```powershell +``` Get-SPOTenantLogLastAvailableTimeInUtc [] ``` @@ -29,11 +29,11 @@ After you know the time, you can use the `Get-SPOTenantLogEntry` cmdlet to retri You must be at least a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOTenantLogLastAvailableTimeInUtc @@ -55,7 +55,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantPreAuthSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantPreAuthSettings.md similarity index 95% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantPreAuthSettings.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantPreAuthSettings.md index 03b6e7c76..c7dc753d7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantPreAuthSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantPreAuthSettings.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantpreauthsettings applicable: SharePoint Online @@ -19,7 +19,7 @@ Gets the configuration of pre-authentication. ## SYNTAX -```powershell +``` Get-SPOTenantPreAuthSettings [] ``` @@ -57,7 +57,7 @@ Gets all the pre-authentication settings for the tenant. Note that this example ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-5.1). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantRenameSitePrioritization.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRenameSitePrioritization.md similarity index 89% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantRenameSitePrioritization.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRenameSitePrioritization.md index e52cac7a7..62568a6a5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantRenameSitePrioritization.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRenameSitePrioritization.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantrenamesiteprioritization applicable: SharePoint Online @@ -31,7 +31,7 @@ You must be at least a SharePoint Online administrator to run the cmdlet. ```powershell Get-SPOTenantRenameSitePrioritization ``` -This example will return the list of sites prioritized for the Advanced Tenant Rename scheduled in the tenant, if one exists. +This example will return the list of sites prioritized for the Advanced Tenant Rename scheduled in the tenant, if one exists. ### Example 2 ```powershell Get-SPOTenantRenameSitePrioritization | Measure-Object @@ -41,14 +41,15 @@ This example will return the count of prioritized sites. ```powershell Get-SPOTenantRenameSitePrioritization | Out-File -FilePath .\sites.txt ``` -This example will download the list of prioritized sites and saves it as file 'sites.txt' in the current directory. +This example will download the list of prioritized sites and saves it as file 'sites.txt' in the current directory. ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS [Advanced Tenant Rename](https://aka.ms/advancedtenantrename) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantRenameStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRenameStatus.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantRenameStatus.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRenameStatus.md index c02437439..6cbc8c304 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantRenameStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRenameStatus.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantrenamestatus applicable: SharePoint Online @@ -21,7 +21,7 @@ Get the status of the job to change the SharePoint domain name for your organiza ## SYNTAX -```Powershell +``` Get-SPOTenantRenameStatus [] ``` @@ -29,7 +29,7 @@ Get-SPOTenantRenameStatus [] This command gets the status of the job to rename the SharePoint domain name for your organization. -> [!NOTE] +> [!NOTE] > If you receive AccessDenied exceptions after the rename operation has started, try connecting to the new domain in PowerShell and try again. ## EXAMPLES @@ -48,9 +48,19 @@ Gets the status of the job to rename your SharePoint domain name. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Rename your SharePoint domain](https://aka.ms/SPOTenantRename) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchAllowedList.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchAllowedList.md new file mode 100644 index 000000000..8c6a1f9b2 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchAllowedList.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOTenantRestrictedSearchAllowedList + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOTenantRestrictedSearchAllowedList [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchMode.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchMode.md new file mode 100644 index 000000000..d542a3f8d --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantRestrictedSearchMode.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Get-SPOTenantRestrictedSearchMode + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-SPOTenantRestrictedSearchMode [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantServicePrincipalPermissionGrants.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantServicePrincipalPermissionGrants.md index 110772680..bef13c14b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantServicePrincipalPermissionGrants.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantserviceprincipalpermissiongrants applicable: SharePoint Online @@ -18,10 +18,8 @@ Gets the collection of permission grants for the "SharePoint Online Client" serv ## SYNTAX -### Default - -```powershell -Get-SPOTenantServicePrincipalPermissionGrants +``` +Get-SPOTenantServicePrincipalPermissionGrants [] ``` ## DESCRIPTION @@ -31,23 +29,35 @@ Gets the collection of permission grants for the "SharePoint Online Client" serv A permission grant contains the following properties: - ClientId: The objectId of the service principal granted consent to impersonate the user when accessing the resource (represented by the resourceId). - - ConsentType: Whether consent was provided by the administrator on behalf of the organization or whether consent was provided by an individual. The possible values are "AllPrincipals" or "Principal". - - ObjectId: The unique identifier for the permission grant. - -- _(Coming soon)_ Resource: The resource to which access has been granted. - +- Resource: The resource to which access has been granted. - ResourceId: The objectId of the resource service principal to which access has been granted. - - Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPOTenantServicePrincipalPermissionGrants ``` Gets the collection of permission grants for the "SharePoint Online Client" service principal. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantServicePrincipalPermissionRequests.md similarity index 65% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantServicePrincipalPermissionRequests.md index e800b9994..30585335a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantServicePrincipalPermissionRequests.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantserviceprincipalpermissionrequests applicable: SharePoint Online @@ -18,10 +18,8 @@ Gets the collection of permission requests for the "SharePoint Online Client" se ## SYNTAX -### Default - -```powershell -Get-SPOTenantServicePrincipalPermissionRequests +``` +Get-SPOTenantServicePrincipalPermissionRequests [] ``` ## DESCRIPTION @@ -40,10 +38,27 @@ A permission request contains the following properties: ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell Get-SPOTenantServicePrincipalPermissionRequests ``` Gets the collection of permission requests for the "SharePoint Online Client" service principal. + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantSyncClientRestriction.md similarity index 91% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantSyncClientRestriction.md index 544414530..88bc7d4ad 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantSyncClientRestriction.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenantsyncclientrestriction applicable: SharePoint Online @@ -18,8 +18,8 @@ Returns the current configuration status. ## SYNTAX -```powershell -Get-SPOTenantSyncClientRestriction +``` +Get-SPOTenantSyncClientRestriction [] ``` ## DESCRIPTION @@ -34,7 +34,7 @@ Requires a valid `Connect-SPOService` context to identify the tenant. For inform ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOTenantSyncClientRestriction diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantTaxonomyReplicationParameters.md similarity index 94% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantTaxonomyReplicationParameters.md index 320080884..a7aca92c4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantTaxonomyReplicationParameters.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotenanttaxonomyreplicationparameters applicable: SharePoint Online @@ -18,7 +18,7 @@ Get the replication parameters to manage Multi-Geo taxonomy replication. ## SYNTAX -```powershell +``` Get-SPOTenantTaxonomyReplicationParameters [] ``` @@ -47,6 +47,16 @@ Gets the replication groups that are being replicated on the current tenant. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTheme.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTheme.md index 3c6415ca0..e34a97257 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTheme.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spotheme applicable: SharePoint Online @@ -14,8 +14,11 @@ ms.reviewer: ## SYNOPSIS -Retrieves settings for an existing theme. +## SYNTAX +``` +Get-SPOTheme [[-Name] ] [] +``` ## DESCRIPTION The **Get-SPOTheme** cmdlet returns the settings for a named existing theme, or for all uploaded themes if no name is provided. @@ -30,7 +33,7 @@ This example shows how to use the **Get-SPOTheme** cmdlet to return the settings Get-SPOTheme -Name "Custom Cyan" | ConvertTo-Json ``` -```powershell +```Output { "Name": "Custom Cyan", "Palette": { @@ -72,12 +75,34 @@ To return all uploaded themes, use the **Get-SPOTheme** command with no argument Get-SPOTheme ``` - +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### System.String + ## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroup.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroup.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroup.md index 613a12568..52d877182 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroup.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spounifiedgroup applicable: SharePoint Online @@ -18,8 +18,8 @@ Retrieves the Preferred Data Location for the specified Office 365 Group. ## SYNTAX -```powershell -Get-SPOUnifiedGroup [-GroupAlias] [] +``` +Get-SPOUnifiedGroup [-GroupAlias] [] ``` ## DESCRIPTION @@ -42,12 +42,12 @@ Returns the PDL for the Office 365 Group named 'EUTeam'. The alias of the Office 365 Group. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -57,8 +57,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES ## RELATED LINKS -[Move a SharePoint site to a different geo location](https://learn.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations) +[Move a SharePoint site to a different geo location](/office365/enterprise/move-sharepoint-between-geo-locations) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroupMoveState.md similarity index 68% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroupMoveState.md index 88ede939b..dbf7281bf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUnifiedGroupMoveState.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spounifiedgroupmovestate applicable: SharePoint Online @@ -18,8 +18,8 @@ Returns the state of an Office 365 Group move between Preferred Data Locations. ## SYNTAX -```powershell -Get-SPOUnifiedGroupMoveState [-GroupAlias] [] +``` +Get-SPOUnifiedGroupMoveState [-GroupAlias] [] ``` ## DESCRIPTION @@ -43,46 +43,12 @@ Returns the status of the move between geos for the Office 365 Group named 'EUTe The alias of the Office 365 Group. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -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` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online -Required: False -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -92,6 +58,10 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + ## OUTPUTS ### System.Object @@ -107,8 +77,9 @@ The move status for the Office 365 Group. Possible values are: * NotSupported: The move could not be processed because the Preferred Data Location was invalid. * Rescheduled: The move did not succeed and is being scheduled again for another attempt. -> [!NOTE] -> You can also apply the `-Verbose` option to see additional information about the move. +## NOTES + +You can also apply the `-Verbose` option to see additional information about the move. ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md index a8e3ff45f..be03a03e5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUser.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spouser applicable: SharePoint Online @@ -18,29 +18,26 @@ Returns the SharePoint Online user or security group accounts that match a given ## SYNTAX -### ByGroup - -```powershell -Get-SPOUser [-Group ] [-Limit ] -Site [] +### All (Default) +``` +Get-SPOUser -Site [-Limit ] [] ``` -### All - -```powershell -Get-SPOUser [-Limit ] -Site [] +### ByGroup +``` +Get-SPOUser -Site [-Group ] [-Limit ] [] ``` ### ByLogin - -```powershell -Get-SPOUser [-LoginName ] -Site [] +``` +Get-SPOUser -Site [-LoginName ] [] ``` ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see [Cmdlet Parameter Sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). +For more information about how to use parameter sets, see [Cmdlet Parameter Sets](/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). The `Get-SPOUser` cmdlet matches one and only one user or security group. @@ -50,7 +47,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance @@ -58,7 +55,7 @@ Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance Example 1 returns all user or security group accounts from the site collection . -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -LoginName melissa.kerr@contoso.com @@ -66,7 +63,7 @@ Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -LoginName meliss Example 2 returns one user or security group account whose user name is "melissa.kerr@contoso.com" from the site collection . -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -Group "Team Site Members" @@ -81,7 +78,7 @@ Example 3 returns one user or security group account inside group Team Site Memb Specifies the group to get the users from. ```yaml -Type: String +Type: System.String Parameter Sets: ByGroup Aliases: Applicable: SharePoint Online @@ -98,8 +95,8 @@ Accept wildcard characters: False 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: String -Parameter Sets: ByGroup, All +Type: System.String +Parameter Sets: All, ByGroup Aliases: Applicable: SharePoint Online @@ -115,7 +112,7 @@ Accept wildcard characters: False Specifies the user name. ```yaml -Type: String +Type: System.String Parameter Sets: ByLogin Aliases: Applicable: SharePoint Online @@ -132,7 +129,7 @@ Accept wildcard characters: False Specifies the URL of the site collection to get the user from. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -156,7 +153,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Get started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md index 5a45cb1f0..ef88772c9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserAndContentMoveState.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spouserandcontentmovestate applicable: SharePoint Online @@ -18,25 +18,22 @@ This cmdlet allows SharePoint administrators to check the status of a user or si ## SYNTAX -### MoveReport - -```powershell -Get-SPOUserAndContentMoveState [-Limit ] [-MoveDirection ] [-MoveEndTime ] - [-MoveStartTime ] [-MoveState ] [] +### MoveReport (Default) ``` - -### OdbMoveId - -```powershell -Get-SPOUserAndContentMoveState -OdbMoveId [] +Get-SPOUserAndContentMoveState [-Limit ] [-MoveStartTime ] [-MoveEndTime ] + [-MoveState ] [-MoveDirection ] [] ``` ### UserPrincipalName - -```powershell +``` Get-SPOUserAndContentMoveState -UserPrincipalName [] ``` +### OdbMoveId +``` +Get-SPOUserAndContentMoveState -OdbMoveId [] +``` + ## DESCRIPTION This command gets the information and the status of a move request of a user between sites in a SharePoint Online Multi Geo tenant. @@ -110,7 +107,7 @@ Obtains the status of the move for jezz@contoso.com Get the limit of user on a single call of the parameter ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: MoveReport Aliases: Applicable: SharePoint Online @@ -127,11 +124,10 @@ Accept wildcard characters: False Allows you to define the direction of the user move in relation to your current SharePoint location ```yaml -Type: Direction +Type: Microsoft.Online.SharePoint.PowerShell.MoveDirection Parameter Sets: MoveReport Aliases: -Accepted values: All, MoveIn, MoveOut -Applicable: SharePoint Online +Accepted values: MoveOut, MoveIn, All Required: False Position: Named @@ -145,7 +141,7 @@ Accept wildcard characters: False Allows you to obtain the moves that are scheduled to end by a particular time, as defined in UTC ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: MoveReport Aliases: Applicable: SharePoint Online @@ -162,7 +158,7 @@ Accept wildcard characters: False Allows you to obtain the moves that are scheduled to begin at a particular time, as defined in UTC ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: MoveReport Aliases: Applicable: SharePoint Online @@ -179,10 +175,10 @@ Accept wildcard characters: False Move State current status. ```yaml -Type: State +Type: Microsoft.Online.SharePoint.PowerShell.MoveState Parameter Sets: MoveReport Aliases: -Accepted values: All, NotStarted, Scheduled, InProgress, Stopped, Success, Failed +Accepted values: NotStarted, InProgress, Success, Failed, Stopped, Queued, NotSupported, Rescheduled, All Applicable: SharePoint Online Required: False @@ -197,7 +193,7 @@ Accept wildcard characters: False OneDrive GUID MoveID that you get when you start a job. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: OdbMoveId Aliases: Applicable: SharePoint Online @@ -230,9 +226,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md index 1647e01bd..24a89104b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOUserOneDriveLocation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spouseronedrivelocation applicable: SharePoint Online @@ -18,7 +18,7 @@ This cmdlet will return the user principal name, current location, and correspon ## SYNTAX -```powershell +``` Get-SPOUserOneDriveLocation -UserPrincipalName [] ``` @@ -28,7 +28,7 @@ This command will return information about the OneDrive location for the specifi ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOUserOneDriveLocation -UserPrincipalName admin@contoso.com @@ -43,7 +43,7 @@ Get the current location the user's OneDrive location, url, and site ID. UserPrincipalName or UPN defined for the specific user on the SPO tenant. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -59,8 +59,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md index 28cd266d9..f69758805 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOWebTemplate.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/get-spowebtemplate applicable: SharePoint Online @@ -18,7 +18,7 @@ Displays all site templates that match the given identity. ## SYNTAX -```powershell +``` Get-SPOWebTemplate [[-LocaleId] ] [-CompatibilityLevel ] [-Name ] [-Title ] [] ``` @@ -29,11 +29,11 @@ The `Get-SPOWebTemplate` cmdlet displays all site templates that match the given You must be at least a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Get-SPOWebTemplate @@ -41,7 +41,7 @@ Get-SPOWebTemplate Example 1 returns all the site templates in the language of the administrator site. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Get-SPOWebTemplate -LocaleID 1036 @@ -56,7 +56,7 @@ Example 2 returns a list of all the French site templates. Specifies the compatibility level of the site template. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -73,7 +73,7 @@ Accept wildcard characters: False Specifies the Locale ID of the site template. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -90,7 +90,7 @@ Accept wildcard characters: False Specifies the name of the site template. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -107,7 +107,7 @@ Accept wildcard characters: False Specifies the Locale ID of the site template. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md similarity index 72% rename from sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md index 09e015737..388b5a2c9 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOHubSiteRights.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/grant-spohubsiterights applicable: SharePoint Online @@ -18,9 +18,9 @@ Grants rights to users or mail-enabled security groups to associate their site w ## SYNTAX -```powershell -Grant-SPOHubSiteRights [-Identity] -Principals - -Rights {Join} [] +``` +Grant-SPOHubSiteRights [-Identity] -Principals + -Rights [] ``` ## DESCRIPTION @@ -48,15 +48,15 @@ This example shows how to grant rights to Nestor (a user at the fictional Contos URL of the hub site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) -Aliases: +Aliases: HubSite Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -65,7 +65,7 @@ Accept wildcard characters: False One or more principals to add permissions for. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -85,6 +85,7 @@ Always set to the value **Join**. Any user or group with **Join** permissions ca Type: String Parameter Sets: (All) Aliases: +Accepted values: Join Applicable: SharePoint Online Required: True @@ -93,3 +94,18 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOSiteDesignRights.md similarity index 68% rename from sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOSiteDesignRights.md index b70028b5a..f08caf591 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Grant-SPOSiteDesignRights.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/grant-spositedesignrights applicable: SharePoint Online @@ -18,12 +18,9 @@ Used to apply permissions to a set of users or a security group, effectively sco ## SYNTAX -```powershell -Grant-SPOSiteDesignRights - [-Identity] - -Principals - -Rights {View} - [] +``` +Grant-SPOSiteDesignRights [-Identity] -Principals + -Rights [] ``` ## DESCRIPTION @@ -50,14 +47,14 @@ Grant-SPOSiteDesignRights ` The ID of the site design to get scoping information. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -66,7 +63,7 @@ Accept wildcard characters: False One or more principles to add permissions for. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -82,9 +79,10 @@ Accept wildcard characters: False Always set to the value **View**. Any user or group with view permissions can view and use the site design. ```yaml -Type: SPOSiteDesignPrincipalRights +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPrincipalRights Parameter Sets: (All) Aliases: +Accepted values: View Applicable: SharePoint Online Required: True Position: Named @@ -92,3 +90,18 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOListDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOListDesign.md new file mode 100644 index 000000000..cf64b41d2 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOListDesign.md @@ -0,0 +1,76 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Invoke-SPOListDesign + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Invoke-SPOListDesign -Identity -WebUrl [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOListDesignPipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -WebUrl +{{ Fill WebUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOListDesignPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md index c17ac727b..fc1c4ee09 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOMigrationEncryptUploadSubmit.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/invoke-spomigrationencryptuploadsubmit applicable: SharePoint Online @@ -14,24 +14,24 @@ ms.reviewer: ## SYNOPSIS -**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](https://learn.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets). +**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets). Creates a new migration job in the target site collection. ## SYNTAX ### ImplicitSourceParameterSet - -```powershell -Invoke-SPOMigrationEncryptUploadSubmit -Credentials - -MigrationSourceLocations [-NoLogFile] -TargetWebUrl [] +``` +Invoke-SPOMigrationEncryptUploadSubmit -MigrationSourceLocations + -Credentials -TargetWebUrl [-NoLogFile] [-ParallelUpload] + [] ``` ### ExplicitSourceParameterSet - -```powershell -Invoke-SPOMigrationEncryptUploadSubmit -Credentials [-NoLogFile] - -SourceFilesPath -SourcePackagePath -TargetWebUrl [] +``` +Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath -SourcePackagePath + -Credentials -TargetWebUrl [-NoLogFile] [-ParallelUpload] + [] ``` ## DESCRIPTION @@ -77,7 +77,7 @@ $jobs = $finalPackages | % {Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesP Parameter to fill out credentials of the SPO tenant. ```yaml -Type: CredentialCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -94,7 +94,7 @@ Accept wildcard characters: False Migration Location where the package lies. ```yaml -Type: MigrationPackageLocation +Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceParameterSet Aliases: Applicable: SharePoint Online @@ -111,7 +111,7 @@ Accept wildcard characters: False Controls if a log will be created or not ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -123,12 +123,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParallelUpload +{{ Fill ParallelUpload Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SourceFilesPath Source files Path, string ```yaml -Type: String +Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: Applicable: SharePoint Online @@ -145,7 +160,7 @@ Accept wildcard characters: False Source Package Path. ```yaml -Type: String +Type: System.String Parameter Sets: ExplicitSourceParameterSet Aliases: Applicable: SharePoint Online @@ -162,7 +177,7 @@ Accept wildcard characters: False Target web URL ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -178,9 +193,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Upload on-premises content to SharePoint Online using PowerShell cmdlets](https://support.office.com/en-us/article/upload-on-premises-content-to-sharepoint-online-using-powershell-cmdlets-555049c6-15ef-45a6-9a1f-a1ef673b867c) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteDesign.md similarity index 76% rename from sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteDesign.md index 0013cf21f..1157d146a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteDesign.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/invoke-spositedesign applicable: SharePoint Online @@ -18,11 +18,8 @@ Applies a published site design to a specified site collection target. This allo ## SYNTAX -```powershell -Invoke-SPOSiteDesign - [-Identity] - -WebUrl - [] +``` +Invoke-SPOSiteDesign -Identity -WebUrl [] ``` ## DESCRIPTION @@ -61,23 +58,22 @@ Add to Hub Site Success The ID of the site design to apply. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -WebUrl - The URL of the site collection where the site design will be applied. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -87,3 +83,18 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteSwap.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteSwap.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md index be1d591ec..6077cef10 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteSwap.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Invoke-SPOSiteSwap.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/invoke-spositeswap applicable: SharePoint Online @@ -17,15 +17,9 @@ Invokes a job to swap the location of a site with another site while archiving t ## SYNTAX -```Powershell -Invoke-SPOSiteSwap - -SourceUrl - -TargetUrl - -ArchiveUrl - [-DisableRedirection] - [-Force] - [-NoWait] - [] +``` +Invoke-SPOSiteSwap [-SourceUrl] [[-TargetUrl] ] [-ArchiveUrl] [-DisableRedirection] + [-Force] [-NoWait] [] ``` ## DESCRIPTION @@ -43,7 +37,7 @@ If the target is the root site at `https://tenant-name.sharepoint.com`, then the 1. Any Featured links defined in SharePoint Start Page at `https://tenant-name.sharepoint.com/_layouts/15/sharepoint.aspx` will not be displayed after performing the swap. If required, the Featured links should be documented so they can be manually recreated after the swap. 2. Functionality such as external sharing and application interfaces are dependent on the policies and permissions defined at the root site. Review the source site to ensure that it has the required policies and permissions as per the existing root site. This includes external sharing settings as well as site permissions. -3. Larger tenants that have more than ~10,000 licenses will need to run the [Page Diagnostic Tool](/office365/enterprise/page-diagnostics-for-spo) against the source site (ensure that the user running the Page Diagnostic Tool has edit rights on the source site). Any analysis results that have the category Attention required (Red) or Improvement opportunities (Orange) will need to be remediated before performing the swap. +3. Larger tenants that have more than ~10,000 licenses will need to run the [Page Diagnostic Tool](/office365/enterprise/page-diagnostics-for-spo) against the source site (ensure that the user running the Page Diagnostic Tool has edit rights on the source site). Any analysis results that have the category Attention required (Red) or Improvement opportunities (Orange) will need to be remediated before performing the swap. The source and target sites can't be connected to an Office 365 group. They also can't be hub sites or associated with a hub. If a site is a hub site, unregister it as a hub site, swap the root site, and then register the site as a hub site. If a site is associated with a hub, disassociate the site, swap the root site, and then reassociate the site. @@ -86,72 +80,67 @@ Archives the existing Search Center site at [-VersionUpgrade] [-QueueOnly] [-NoEmail] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoEmail +{{ Fill NoEmail Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QueueOnly +{{ Fill QueueOnly Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VersionUpgrade +{{ Fill VersionUpgrade Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md similarity index 99% rename from sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index 16ad449b1..88562af75 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -1,19 +1,19 @@ --- Module Name: Microsoft.Online.SharePoint.PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -title: sharepoint-online +Module Guid: adedde5f-e77b-4682-ab3d-a4cb4ff79b83 +title: Microsoft.Online.SharePoint.PowerShell Module +Locale: en-US author: trent-green ms.author: trgreen ms.reviewer: --- -# SharePoint Online PowerShell - +# Microsoft.Online.SharePoint.PowerShell Module ## Description The following cmdlet references are for SharePoint Online. -## sharepoint-online Cmdlets +## Microsoft.Online.SharePoint.PowerShell Cmdlets ### [Add-SPOContainerTypeBilling](Add-SPOContainerTypeBilling.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOAppBillingPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md similarity index 76% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOAppBillingPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md index 3e0299b13..1e69d04d7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOAppBillingPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOAppBillingPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/New-SPOAppBillingPolicy applicable: SharePoint Online @@ -17,19 +17,14 @@ Creates a new billing policy for an application owned by the tenant. ## SYNTAX -```powershell - -New-SPOAppBillingPolicy -[[-ApplicationId] ] -[[-AzureSubscriptionId] ] -[[-ResourceGroup] ] -[[-AzureRegion] ] -[[-UsageCharges] ] +``` +New-SPOAppBillingPolicy -ApplicationId -UsageCharges -AzureSubscriptionId + -ResourceGroup -AzureRegion [] ``` ## DESCRIPTION -This cmdlet creates a new billing policy for an application that is owned by the tenant running the cmdlet. +This cmdlet creates a new billing policy for an application that is owned by the tenant running the cmdlet. You must be a SharePoint Administrator to run this cmdlet. @@ -37,11 +32,11 @@ You must be a SharePoint Administrator to run this cmdlet. > To use the New-SPOAppBillingPolicy cmdlet, an admin must authenticate to SharePoint Online using modern authentication. > > Use the **Connect-SPOService** cmdlet shown below, which will prompt you to enter your credentials. If multi-factor authentication (MFA) is enabled, you will need to complete the MFA process (e.g., entering a verification code sent to your phone). -> +> > > `Connect-SPOService -Url https://(your-tenant)-admin.sharepoint.com` > -> Replace (your-tenant) with your actual SharePoint Online domain, e.g. `https://contoso-admin.sharepoint.com.` +> Replace (your-tenant) with your actual SharePoint Online domain, e.g. `https://contoso-admin.sharepoint.com.` ## EXAMPLES @@ -64,9 +59,9 @@ New-SPOAppBillingPolicy -ApplicationId 50785fde-3082-47ac-a36d-06282ac5c7da -Az ### -ApplicationID This parameter specifies the ID of the application. - + ```yaml -Type: GUID +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -78,13 +73,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AzureSubscriptionId +### -AzureRegion + +The region of the Azure Subscription. -The unique identifier of the Azure Active Directory profile (Microsoft Entra ID) for billing purposes. - ```yaml -Type: GUID -Parameter Sets: Standard +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -95,13 +90,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroup +### -AzureSubscriptionId + +The unique identifier of the Azure Active Directory profile (Microsoft Entra ID) for billing purposes. -Resource Group Name associated with the Azure Subscription - ```yaml -Type: String -Parameter Sets: Standard +Type: System.Guid +Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -112,13 +107,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AzureRegion +### -ResourceGroup + +Resource Group Name associated with the Azure Subscription -The region of the Azure Subscription. - ```yaml -Type: String -Parameter Sets: Standard +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -134,10 +129,10 @@ Accept wildcard characters: False 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. - + ```yaml -Type: Switch -Parameter Sets: All +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -147,7 +142,21 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOContainerType.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md index 576466b7f..4636e7e36 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOContainerType.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spocontainertype applicable: SharePoint Online @@ -18,14 +18,16 @@ This cmdlet creates a new container type of standard or trial status. The standa ## SYNTAX -```powershell -New-SPOContainerType [-ContainerTypeName] -OwningApplicationId [-ApplicationRedirectUrl ] [-TrialContainerType] [-IsPassThroughBilling] [-IsGovernableByAdmin ] [-WhatIf] [-Confirm] [] +``` +New-SPOContainerType [-ContainerTypeName] -OwningApplicationId + [-ApplicationRedirectUrl ] [-TrialContainerType] [-IsPassThroughBilling] + [-IsGovernableByAdmin ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -This cmdlet creates a new standard or trial container type. A standard container type, by definition, has a billing profile associated with it and can be either regular billed or direct to consumer billed. A trial container type does not have a billing profile. In case of regular billing, the next step after creation is the addition of a billing profile using the [Add-SPOContainerTypeBilling](./Add-SPOContainerTypeBilling.md) cmdlet. With the use of `-IsPassThroughBilling`, you can create a direct to customer billed container type. There is no need to attach a billing profile in case this case. `–TrialContainerType` when used creates a trial container type that has a validity of 30 days. +This cmdlet creates a new standard or trial container type. A standard container type, by definition, has a billing profile associated with it and can be either regular billed or direct to consumer billed. A trial container type does not have a billing profile. In case of regular billing, the next step after creation is the addition of a billing profile using the [Add-SPOContainerTypeBilling](./Add-SPOContainerTypeBilling.md) cmdlet. With the use of `-IsPassThroughBilling`, you can create a direct to customer billed container type. There is no need to attach a billing profile in case this case. `–TrialContainerType` when used creates a trial container type that has a validity of 30 days. You must be a SharePoint Embedded Administrator to run this cmdlet. @@ -35,44 +37,44 @@ You must be a SharePoint Embedded Administrator to run this cmdlet. ### Example 1 ```powershell -New-SPOContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af +New-SPOContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af ``` In Example 1, the cmdlet creates a new regular billed container type ContosoLegal. -### Example 2 +### Example 2 ```powershell New-SPOContainerType –IsPassThroughBilling –ContainerTypeName ContosoLegal -OwningApplicationId a735e4af ``` -In Example 2, the cmdlet creates a direct to customer billed container type ContosoLegal. +In Example 2, the cmdlet creates a direct to customer billed container type ContosoLegal. -### Example 3 +### Example 3 -```powershell +```powershell New-SPOContainerType –TrialContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af -``` +``` -In Example 3, the cmdlet creates a trial container type, ContosoLegal, valid for 30 days. +In Example 3, the cmdlet creates a trial container type, ContosoLegal, valid for 30 days. -### Example 4 +### Example 4 -```powershell +```powershell New-SPOContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af -GovernableByAdmin $false -``` +``` -In Example 4, the cmdlet creates a standard container type, ContosoLegal that has opted out of management through Microsoft-enabled administrator platforms. +In Example 4, the cmdlet creates a standard container type, ContosoLegal that has opted out of management through Microsoft-enabled administrator platforms. ## PARAMETERS ### -ApplicationRedirectUrl -This parameter specifies the url of that the application should be redirected to. +This parameter specifies the url of that the application should be redirected to. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -89,7 +91,7 @@ Accept wildcard characters: False This parameter names your container type for your SharePoint Embedded application. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -101,12 +103,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### –GovernableByAdmin +### -IsGovernableByAdmin 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: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -118,7 +120,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### –IsPassThroughBilling +### -IsPassThroughBilling This parameter is used to create a direct to customer billed container type. @@ -137,10 +139,10 @@ Accept wildcard characters: False ### -OwningApplicationId -This parameter specifies the ID of the SharePoint Embedded application. +This parameter specifies the ID of the SharePoint Embedded application. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -152,13 +154,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` - -### –TrialContainerType +### -TrialContainerType 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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -170,8 +171,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOListFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md similarity index 68% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOListFileVersionBatchDeleteJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md index bed408574..3578dbd9c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOListFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spolistfileversionbatchdeletejob applicable: SharePoint Online @@ -19,8 +19,22 @@ Queues a job to trim versions from a document library. ## SYNTAX -```powershell -New-SPOListFileVersionBatchDeleteJob [-Site] [-List] [-Automatic] [-DeleteBeforeDays ] [-MajorVersionLimit ] [-MajorWithMinorVersionsLimit ] [] +### AutomaticTrim +``` +New-SPOListFileVersionBatchDeleteJob [-Site] -List [-Automatic] [-WhatIf] + [-Confirm] [] +``` + +### DeleteOlderThanDays +``` +New-SPOListFileVersionBatchDeleteJob [-Site] -List + [-DeleteBeforeDays ] [-WhatIf] [-Confirm] [] +``` + +### CountLimits +``` +New-SPOListFileVersionBatchDeleteJob [-Site] -List + -MajorVersionLimit -MajorWithMinorVersionsLimit [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -57,19 +71,33 @@ Example 3 starts a trim job that will delete file versions in the document libra ## PARAMETERS -### -Site +### -Automatic +Trim file versions using automatic version history limit algorithm. -Specifies the URL of the site. +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AutomaticTrim +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteBeforeDays +The minimum age of file versions to trim. In other words, all file versions that are older than this number of days will be deleted. ```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) +Type: System.Int32 +Parameter Sets: DeleteOlderThanDays Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 + +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -78,36 +106,39 @@ Accept wildcard characters: False The document library name or Id. ```yaml -Type: SPOListPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind Parameter Sets: (All) +Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Automatic -Trim file versions using automatic version history limit algorithm. +### -MajorVersionLimit +Trim file version using version count limits. Need to specify `MajorWithMinorVersionsLimit` as well. ```yaml -Type: SwitchParameter -Parameter Sets: AutomaticTrim +Type: System.Int32 +Parameter Sets: CountLimits +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DeleteBeforeDays -The minimum age of file versions to trim. In other words, all file versions that are older than this number of days will be deleted. +### -MajorWithMinorVersionsLimit +Trim file version using version count limits. Need to specify `MajorVersionLimit` as well. ```yaml -Type: int -Parameter Sets: DeleteOlderThanDays +Type: System.Int32 +Parameter Sets: CountLimits +Aliases: Required: True Position: Named @@ -116,12 +147,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MajorVersionLimit -Trim file version using version count limits. Need to specify `MajorWithMinorVersionsLimit` as well. +### -Site + +Specifies the URL of the site. ```yaml -Type: int -Parameter Sets: CountLimits +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -130,12 +178,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MajorWithMinorVersionsLimit -Trim file version using version count limits. Need to specify `MajorVersionLimit` as well. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: int -Parameter Sets: CountLimits +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -148,6 +198,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +### Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOListFileVersionBatchDeleteJobProgress](Get-SPOListFileVersionBatchDeleteJobProgress.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOListFileVersionExpirationReportJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionExpirationReportJob.md similarity index 66% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOListFileVersionExpirationReportJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionExpirationReportJob.md index 9cf2f6685..51ac9780a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOListFileVersionExpirationReportJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionExpirationReportJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spolistfileversionexpirationreportjob applicable: SharePoint Online @@ -19,8 +19,9 @@ Starts generating file version expiration report for a document library. ## SYNTAX -```powershell -New-SPOListFileVersionExpirationReportJob [-Site] [-List] [-ReportUrl ] [] +``` +New-SPOListFileVersionExpirationReportJob [-Site] -List -ReportUrl + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,29 +40,30 @@ Example 1 starts generating file version expiration report on for the document l ## PARAMETERS -### -Site +### -List -Specifies the URL of the site. +The document library name or Id. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -List +### -ReportUrl -The document library name or Id. +The URL of the report to save to. ```yaml -Type: SPOListPipeBind +Type: System.String Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -70,15 +72,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportUrl +### -Site -The URL of the report to save to. +Specifies the URL of the site. ```yaml -Type: string +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) - +Aliases: +Applicable: SharePoint Online Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -89,6 +123,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +### Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOListFileVersionExpirationReportJobProgress](Get-SPOListFileVersionExpirationReportJobProgress.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationEncryptionParameters.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationEncryptionParameters.md index 955f79f9c..08f03f2b3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationEncryptionParameters.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spomigrationencryptionparameters applicable: SharePoint Online @@ -14,13 +14,13 @@ ms.reviewer: ## SYNOPSIS -**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](https://learn.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets). +**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets). Creates a new random encryption key for a migration job or package. ## SYNTAX -```powershell +``` New-SPOMigrationEncryptionParameters [] ``` @@ -44,16 +44,22 @@ Outputs a random encryption key and saves it in the `$o` variable. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + ## OUTPUTS -### System.Byte +### System.Byte[] -EncryptionKey: The randomly generated encryption key using [System.Security.Cryptography.AesCryptoServiceProvider](https://learn.microsoft.com/dotnet/api/system.security.cryptography.aescryptoserviceprovider) class. +EncryptionKey: The randomly generated encryption key using [System.Security.Cryptography.AesCryptoServiceProvider](/dotnet/api/system.security.cryptography.aescryptoserviceprovider) class. ### Microsoft.Online.SharePoint.Migration.SPMigrationJobEncryptionMethod EncryptionMethod: The encryption algorithm used to generate the EncryptionKey. Currently hardcoded to AES256BC. +## NOTES + ## RELATED LINKS [Submit-SPOMigrationjob](Submit-SPOMigrationJob.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md index efae0f417..bf5e36dcf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOMigrationPackage.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spomigrationpackage applicable: SharePoint Online @@ -13,18 +13,18 @@ ms.reviewer: # New-SPOMigrationPackage ## SYNOPSIS +Cmdlet to create a new migration package based on source files in a local or network shared folder. > [!NOTE] -> This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](https://learn.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets). - -Cmdlet to create a new migration package based on source files in a local or network shared folder. +> This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see +> [Migrate to SharePoint using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets). ## SYNTAX -```powershell +``` New-SPOMigrationPackage [-SourceFilesPath] [-OutputPackagePath] [[-TargetWebUrl] ] - [[-TargetDocumentLibraryPath] ] [[-TargetDocumentLibrarySubFolderPath] ] [-IgnoreHidden] - [-IncludeFileSharePermissions] [-NoAzureADLookup] [-NoLogFile] [-ReplaceInvalidCharacters] + [[-TargetDocumentLibraryPath] ] [[-TargetDocumentLibrarySubFolderPath] ] + [-IncludeFileSharePermissions] [-ReplaceInvalidCharacters] [-IgnoreHidden] [-NoLogFile] [-NoAzureADLookup] [] ``` @@ -32,24 +32,9 @@ New-SPOMigrationPackage [-SourceFilesPath] [-OutputPackagePath] [!NOTE] -> Limits on the SPO package size and file size -> -> | Limit | Max Size (Gb) | Description | -> | :---: | :---: | :---: | -> | Package Size | 2-4 | The whole package can't exceed 4Gb | -> | File Size | 2 | A single file inside the source folder can't exceed 2 Gb. | -> | Target Size | -| target site should remain non-accessible to end user until migration is complete| -> [!NOTE] -> Limits on HTTP Get -> -> | Limit | API Get (chars) | Description | -> | :---: | :---: | :---: | -> | Action GET on API | 260 chars | The size of the API GET request can't exceed 260 chars| - ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg @@ -59,7 +44,7 @@ New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPacka This example creates a new set of migration source package metadata files, using default URL values, in the d:\MigrationPackages\Folder1_SrcPkg directory based on content files found in the \\fileserver\share\folder1 source location. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg -TargetWebUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -TargetDocumentLibraryPath "Shared Documents" @@ -74,7 +59,7 @@ This example creates a new set of migration source package metadata files in the Switch to ignore hidden files and folders. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -91,7 +76,7 @@ Accept wildcard characters: False Used to include permissions and sharing information into the generated manifest files in the package metadata. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -108,7 +93,7 @@ Accept wildcard characters: False Switch to not lookup local user accounts in Microsoft Entra ID. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -125,7 +110,7 @@ Accept wildcard characters: False 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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -142,7 +127,7 @@ Accept wildcard characters: False The directory location where the output package metadata files will be saved. If the directory does not exist, it will be created. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -159,7 +144,7 @@ Accept wildcard characters: False Switch to replace characters in file and folder names that would be invalid in SharePoint Online. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -176,7 +161,7 @@ Accept wildcard characters: False The directory location where the source content files exist. This directory will be enumerated to create the package metadata files. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -193,7 +178,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -210,7 +195,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -224,10 +209,10 @@ Accept wildcard characters: False ### -TargetWebUrl -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, "`http://fileserver/sites/user`" will be used instead within the package metadata. +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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -253,4 +238,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES +Limits on the SPO package size and file size + +| Limit | Max Size (Gb) | Description | +| ------------ | :-----------: | -------------------------------------------------------------------------------- | +| Package Size | 2-4 | The whole package can't exceed 4Gb | +| File Size | 2 | A single file inside the source folder can't exceed 2 Gb. | +| Target Size | - | target site should remain non-accessible to end user until migration is complete | + +Limits on HTTP Get + +| Limit | API Get (chars) | Description | +| ----------------- | :-------------: | ------------------------------------------------------ | +| Action GET on API | 260 chars | The size of the API GET request can't exceed 260 chars | + ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPortalLaunchWaves.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPortalLaunchWaves.md new file mode 100644 index 000000000..cf95eb6ec --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPortalLaunchWaves.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# New-SPOPortalLaunchWaves + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-SPOPortalLaunchWaves -LaunchSiteUrl -RedirectionType + -ExpectedNumberOfUsers [-RedirectUrl ] [-WaveSetupJsonFilepath ] + [-Waves ] -WaveOverrideUsers [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ExpectedNumberOfUsers +{{ Fill ExpectedNumberOfUsers Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Publishing.PortalLaunch.PortalLaunchUsersSizeType +Parameter Sets: (All) +Aliases: +Accepted values: LessThan10kUsers, From10kTo30kUsers, From30kTo100KUsers, MoreThan100kUsers + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LaunchSiteUrl +{{ Fill LaunchSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectionType +{{ Fill RedirectionType Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Publishing.PortalLaunch.PortalLaunchRedirectionType +Parameter Sets: (All) +Aliases: +Accepted values: Bidirectional, ToTemporaryPage, SiteBased + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RedirectUrl +{{ Fill RedirectUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaveOverrideUsers +{{ Fill WaveOverrideUsers Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Waves +{{ Fill Waves Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WaveSetupJsonFilepath +{{ Fill WaveSetupJsonFilepath Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOPublicCdnOrigin.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md index 973ddb985..4d89d6d69 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOPublicCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOPublicCdnOrigin.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spopubliccdnorigin applicable: SharePoint Online @@ -18,8 +18,8 @@ Creates a new public CDN on a document library in your SharePoint Online Tenant ## SYNTAX -```powershell -New-SPOPublicCdnOrigin [-Url] [-Confirm] [-WhatIf] [] +``` +New-SPOPublicCdnOrigin [-Url] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,37 +38,37 @@ This example shows how to you can setup a new Public CDN on a document library i ## PARAMETERS -### -Confirm +### -Url -Prompts you for confirmation before running the cmdlet. +Specify the URL that will be enabled for Public CDN in your tenant ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Url +### -Confirm -Specify the URL that will be enabled for Public CDN in your tenant +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -78,7 +78,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -94,6 +94,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md index 9a8cf473a..683437283 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSdnProvider.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-sposdnprovider applicable: SharePoint Online @@ -18,8 +18,8 @@ Adds a new Software-Defined Networking (SDN) provider ## SYNTAX -```powershell -New-SPOSdnProvider [-Identity] [-License] [-Confirm] [-WhatIf] [] +``` +New-SPOSdnProvider [-Identity] [-License] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,54 +38,54 @@ This example creates the Hive for a SDN Provider. ## PARAMETERS -### -Confirm +### -Identity -Prompts you for confirmation before running the cmdlet. +Identity of the provider. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Identity +### -License -Identity of the provider. +License key provided by the provider. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 0 +Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -License +### -Confirm -License key provided by the provider. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -95,7 +95,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -111,6 +111,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOServicePrioritizationBillingPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOServicePrioritizationBillingPolicy.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOServicePrioritizationBillingPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOServicePrioritizationBillingPolicy.md index 6dea4397f..ab5f60f17 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOServicePrioritizationBillingPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOServicePrioritizationBillingPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/New-SPOServicePrioritizationBillingPolicy applicable: SharePoint Online @@ -41,7 +41,7 @@ This example creates a new billing policy for service prioritization with the sp Specifies the Azure region where the billing policy applies. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -56,7 +56,7 @@ Accept wildcard characters: False Specifies the unique identifier (GUID) of the Azure subscription associated with the billing policy. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -71,7 +71,7 @@ Accept wildcard characters: False Specifies a user-friendly name for the billing policy. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -86,7 +86,7 @@ Accept wildcard characters: False Specifies the Azure resource group associated with the billing policy. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -98,7 +98,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -107,6 +107,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS @@ -121,4 +122,4 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar [Get-SPOServicePrioritizationBillingPolicies](./Get-SPOServicePrioritizationBillingPolicies.md) -[Set-SPOServicePrioritizationAppRegistration](./Set-SPOServicePrioritizationAppRegistration.md) \ No newline at end of file +[Set-SPOServicePrioritizationAppRegistration](./Set-SPOServicePrioritizationAppRegistration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md index 683749161..35f05a55f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-sposite applicable: SharePoint Online @@ -18,10 +18,10 @@ Creates a new SharePoint Online site collection for the current company. ## SYNTAX -```powershell -New-SPOSite [-CompatibilityLevel ] [-LocaleId ] [-NoWait] -Owner - [-ResourceQuota ] -StorageQuota [-Template ] [-TimeZoneId ] [-Title ] - -Url [] +``` +New-SPOSite -Url -Owner -StorageQuota [-Title ] + [-Template ] [-LocaleId ] [-CompatibilityLevel ] [-ResourceQuota ] + [-TimeZoneId ] [-NoWait] [-EnableAgreementsSolution] [] ``` ## DESCRIPTION @@ -35,7 +35,7 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell New-SPOSite -Url https://contoso.sharepoint.com/sites/mynewsite -Owner joe.healy@contoso.com -StorageQuota 1000 -Title "My new site collection" @@ -43,7 +43,7 @@ New-SPOSite -Url https://contoso.sharepoint.com/sites/mynewsite -Owner joe.healy Example 1 creates a new site collection for the current company with specified site URL, title and owner. The storage quota is set to 1000 megabytes. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell New-SPOSite -Url https://contoso.sharepoint.com/sites/mynewsite -Owner joe.healy@contoso.com -StorageQuota 1000 -CompatibilityLevel 15 -LocaleID 1033 -ResourceQuota 300 -Template "STS#0" -TimeZoneId 13 -Title "My new site collection" @@ -51,7 +51,7 @@ New-SPOSite -Url https://contoso.sharepoint.com/sites/mynewsite -Owner joe.healy Example 2 creates a new site collection for the current company with specified site URL, title, owner and template. The storage quota is set to 1000 megabytes and the resource quota is set to 300 megabytes. The template compatibility level is set to 15 which means that the site collection only supports the SharePoint 2013 template. The language is set to English - United States (LocaleID = 1033) and the time zone is set to (GMT-08:00) Pacific Time (US and Canada) (TimeZone = 13). -### -----------------------EXAMPLE 3----------------------------- +### EXAMPLE 3 ```powershell New-SPOSite -Url https://contoso.sharepoint.com/sites/accounting -Owner admin@contoso.com -StorageQuota 100 -NoWait -ResourceQuota 50 -Template STS#0 @@ -66,7 +66,7 @@ Example 3 creates a new site collection for the current company with specified s This parameter no longer has any effect and only accepts a value of '15'. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -78,12 +78,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableAgreementsSolution +{{ Fill EnableAgreementsSolution Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocaleId 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: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -100,7 +115,7 @@ Accept wildcard characters: False Specifies to continue executing script immediately. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -117,7 +132,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -131,10 +146,10 @@ Accept wildcard characters: False ### -ResourceQuota -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](https://learn.microsoft.com/previous-versions/office/developer/sharepoint-2010/gg615462(v=office.14)). Note that this parameter is now obsolete and has been deprecated. +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: Double +Type: System.Double Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -151,7 +166,7 @@ Accept wildcard characters: False Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. ```yaml -Type: Int64 +Type: System.Int64 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -168,7 +183,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -185,7 +200,7 @@ Accept wildcard characters: False 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: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -202,7 +217,7 @@ Accept wildcard characters: False Specifies the title of the site collection. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -219,7 +234,7 @@ Accept wildcard characters: False 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: UrlCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -243,7 +258,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOSite](Get-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionBatchDeleteJob.md similarity index 71% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteFileVersionBatchDeleteJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionBatchDeleteJob.md index 87138cc8f..a8424cde7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionBatchDeleteJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spositefileversionbatchdeletejob applicable: SharePoint Online @@ -19,8 +19,22 @@ Queues a job to trim versions for all document libraries in a site collection. ## SYNTAX -```powershell -New-SPOSiteFileVersionBatchDeleteJob [-Identity] [-Automatic] [-DeleteBeforeDays ] [-MajorVersionLimit ] [-MajorWithMinorVersionsLimit ] [] +### AutomaticTrim +``` +New-SPOSiteFileVersionBatchDeleteJob [-Identity] [-Automatic] [-WhatIf] [-Confirm] + [] +``` + +### DeleteOlderThanDays +``` +New-SPOSiteFileVersionBatchDeleteJob [-Identity] [-DeleteBeforeDays ] [-WhatIf] + [-Confirm] [] +``` + +### CountLimits +``` +New-SPOSiteFileVersionBatchDeleteJob [-Identity] -MajorVersionLimit + -MajorWithMinorVersionsLimit [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -57,42 +71,74 @@ Example 3 starts a trim job that will delete file versions in the site collectio ## PARAMETERS +### -Automatic +Trim file versions using automatic version history limit algorithm. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: AutomaticTrim +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteBeforeDays +The minimum age of file versions to trim. In other words, all file versions that are older than this number of days will be deleted. + +```yaml +Type: System.Int32 +Parameter Sets: DeleteOlderThanDays +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Specifies the URL of the site collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Automatic -Trim file versions using automatic version history limit algorithm. +### -MajorVersionLimit +Trim file version using version count limits. Need to specify `MajorWithMinorVersionsLimit` as well. ```yaml -Type: SwitchParameter -Parameter Sets: AutomaticTrim +Type: System.Int32 +Parameter Sets: CountLimits +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DeleteBeforeDays -The minimum age of file versions to trim. In other words, all file versions that are older than this number of days will be deleted. +### -MajorWithMinorVersionsLimit +Trim file version using version count limits. Need to specify `MajorVersionLimit` as well. ```yaml -Type: int -Parameter Sets: DeleteOlderThanDays +Type: System.Int32 +Parameter Sets: CountLimits +Aliases: Required: True Position: Named @@ -101,12 +147,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MajorVersionLimit -Trim file version using version count limits. Need to specify `MajorWithMinorVersionsLimit` as well. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: int -Parameter Sets: CountLimits +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -115,12 +162,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MajorWithMinorVersionsLimit -Trim file version using version count limits. Need to specify `MajorVersionLimit` as well. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: int -Parameter Sets: CountLimits +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -133,6 +182,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOSiteFileVersionBatchDeleteJobProgress](Get-SPOSiteFileVersionBatchDeleteJobProgress.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteFileVersionExpirationReportJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionExpirationReportJob.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteFileVersionExpirationReportJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionExpirationReportJob.md index 2a5494361..5d5620a0b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteFileVersionExpirationReportJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteFileVersionExpirationReportJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spositefileversionexpirationreportjob applicable: SharePoint Online @@ -19,8 +19,9 @@ Generates a version storage usage report for a site collection. This report can ## SYNTAX -```powershell -New-SPOSiteFileVersionExpirationReportJob [-Identity] [-ReportUrl ] [] +``` +New-SPOSiteFileVersionExpirationReportJob [-Identity] -ReportUrl [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -44,12 +45,12 @@ Example 1 starts generating file version expiration report on for the site colle Specifies the URL of the site collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False @@ -60,8 +61,9 @@ Accept wildcard characters: False The URL of the report to save to. ```yaml -Type: string +Type: System.String Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -70,10 +72,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOSiteFileVersionExpirationReportJobProgress](Get-SPOSiteFileVersionExpirationReportJobProgress.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md index 2ea5e8b49..63fc08ddb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteGroup.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/new-spositegroup applicable: SharePoint Online @@ -18,8 +18,8 @@ Creates a new group in a SharePoint Online site collection. ## SYNTAX -```powershell -New-SPOSiteGroup -Group -PermissionLevels -Site [] +``` +New-SPOSiteGroup -Site -Group -PermissionLevels [] ``` ## DESCRIPTION @@ -29,11 +29,11 @@ SharePoint groups enable you to manage sets of users instead of individual users You must be at least a SharePoint Online administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell New-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -Group "Project Leads" -PermissionLevels "Full Control" @@ -41,7 +41,7 @@ New-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -Group "Projec This example creates a group named Project Leads with the Full Control permission level on the site collection -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell New-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/marketing -Group "NewGroupName" -PermissionLevels "Design" @@ -56,7 +56,7 @@ This example creates a group named NewGroupName with the Design permission level Specifies the name of the group to add. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -73,10 +73,10 @@ Accept wildcard characters: False 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] -> Permission Levels, are defined on the top-level site of the site collection, please see [How to create and edit permission levels](https://learn.microsoft.com/sharepoint/how-to-create-and-edit-permission-levels) for more information. +> Permission Levels, are defined on the top-level site of the site collection, please see [How to create and edit permission levels](/sharepoint/how-to-create-and-edit-permission-levels) for more information. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -93,7 +93,7 @@ Accept wildcard characters: False Specifies the site collection to add the group to. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -117,6 +117,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [New-SPOSite](New-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteSharingReportJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteSharingReportJob.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteSharingReportJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteSharingReportJob.md index ee0746a08..0009b13ab 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteSharingReportJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOSiteSharingReportJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml Module Name: Microsoft.Online.SharePoint.PowerShell online version: https://docs.microsoft.com/powershell/module/sharepoint-online/New-SPOSiteSharingReportJob applicable: SharePoint Online @@ -18,16 +18,17 @@ Creates a new sharing report job. ## SYNTAX -```powershell -New-SPOSiteSharingReportJob [-Site] [-ReportStorageWebUrl] [-ReportStorageFolderUrl] [] +``` +New-SPOSiteSharingReportJob [-Site] [-ReportStorageWebUrl] + [-ReportStorageFolderUrl] [] ``` ## DESCRIPTION -This cmdlet is not currently active in Production and may be removed in the future. You will receive the error, "Site collection sharing report feature has not been enabled", if you run this cmdlet which is currently by design. +This cmdlet is not currently active in Production and may be removed in the future. You will receive the error, "Site collection sharing report feature has not been enabled", if you run this cmdlet which is currently by design. ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell $site = Get-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 @@ -39,15 +40,15 @@ New-SPOSiteSharingReportJob -Site $site -ReportStorageWebUrl 'https://contoso.sh ### -ReportStorageFolderUrl -Location to where the report will be exported. +Location to where the report will be exported. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -58,12 +59,12 @@ Accept wildcard characters: False Report web storage URL. ```yaml -Type: String[] +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -74,12 +75,12 @@ Accept wildcard characters: False Specifies the site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -91,9 +92,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS ### System.Object ## NOTES +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md similarity index 66% rename from sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md index a61f78694..cf162de9e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPODataEncryptionPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/register-spodataencryptionpolicy applicable: SharePoint Online @@ -15,18 +15,27 @@ ms.reviewer: ## SYNOPSIS Cmdlet to register customer encryption status for your geo tenant. -For more information, see [Controlling your data in Office 365 using Customer Key](https://learn.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) +For more information, see [Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) ## SYNTAX -```powershell -Register-SPODataEncryptionPolicy -PrimaryKeyVaultName -PrimaryKeyName -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName -SecondaryKeyVersion [-WhatIf] [-Confirm] [] +### BYOK_MultipleParameters (Default) +``` +Register-SPODataEncryptionPolicy -PrimaryKeyVaultName -PrimaryKeyName + -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName + -SecondaryKeyVersion [-WhatIf] [-Confirm] [] +``` + +### BYOK_Uri +``` +Register-SPODataEncryptionPolicy -PrimaryKeyVaultUri -SecondaryKeyVaultUri [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION Use the Register-DataEncryptionPolicy cmdlet to register customer encryption status for your geo tenant. -For more information, see [Controlling your data in Office 365 using Customer Key](https://learn.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) +For more information, see [Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) ## EXAMPLES @@ -39,13 +48,13 @@ This example registers the DEP used with SharePoint Online and OneDrive for Busi ## PARAMETERS -### -PrimaryKeyVaultName +### -PrimaryKeyName -The name of the primary key vault +The name of the primary key ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -55,13 +64,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryKeyName +### -PrimaryKeyVaultName -The name of the primary key +The name of the primary key vault ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -71,13 +80,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PrimaryKeyVaultUri +{{ Fill PrimaryKeyVaultUri Description }} + +```yaml +Type: System.Uri +Parameter Sets: BYOK_Uri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PrimaryKeyVersion The version of the primary key ```yaml -Type: Guid -Parameter Sets: (All) +Type: System.Guid +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -87,13 +111,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryKeyVaultName +### -SecondaryKeyName -The name of the secondary key vault +The name of the secondary key ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -103,13 +127,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryKeyName +### -SecondaryKeyVaultName -The name of the secondary key +The name of the secondary key vault ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -119,13 +143,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SecondaryKeyVaultUri +{{ Fill SecondaryKeyVaultUri Description }} + +```yaml +Type: System.Uri +Parameter Sets: BYOK_Uri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SecondaryKeyVersion The version of the secondary key ```yaml -Type: Guid -Parameter Sets: (All) +Type: System.Guid +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -135,14 +174,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf - -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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Applicable: SharePoint Online Required: False Position: Named @@ -151,18 +189,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding. - -- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false. +### -WhatIf -- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding. +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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Applicable: SharePoint Online Required: False Position: Named @@ -175,4 +209,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md index 4f76cbe39..3d0988566 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Register-SPOHubSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/register-spohubsite applicable: SharePoint Online @@ -14,12 +14,12 @@ ms.reviewer: ## SYNOPSIS -Enables the hub site feature on a site to make it a hub site. For more information visit [SharePoint hub sites overview](https://learn.microsoft.com/sharepoint/dev/features/hub-site/hub-site-overview). +Enables the hub site feature on a site to make it a hub site. For more information visit [SharePoint hub sites overview](/sharepoint/dev/features/hub-site/hub-site-overview). ## SYNTAX -```powershell -Register-SPOHubSite -Site -Principals [] +``` +Register-SPOHubSite [-Site] -Principals [] ``` ## DESCRIPTION @@ -43,12 +43,12 @@ This example registers the marketing site on Contoso as hub site without setting ## PARAMETERS -### -Site +### -Principals -Specifies the URL of the site collection to which to enable the hub site features. +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: SpoSitePipeBind +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -60,23 +60,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Principals +### -Site -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. +Specifies the URL of the site collection to which to enable the hub site features. ```yaml -Type: string[] +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + ## NOTES If the site doesn't exist, this cmdlet returns a "File not found" error. @@ -84,3 +95,5 @@ If the site doesn't exist, this cmdlet returns a "File not found" error. If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error. If the site is already associated with another hub site, this cmdlet returns a "This site is currently associated with a HubSite" error. You'll need to run the [Remove-SPOHubSiteAssociation](Remove-SPOHubSiteAssociation.md) cmdlet first before you can make the site a hub site. + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppBillingPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md similarity index 56% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppBillingPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md index 12e2a088a..6ed67e914 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppBillingPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOAppBillingPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Remove-SPOAppBillingPolicy applicable: SharePoint Online @@ -17,14 +17,13 @@ Removes billing policy asscoiated with the application. ## SYNTAX -```powershell - -Remove-SPOAppBillingPolicy [[-ApplicationId] ] +``` +Remove-SPOAppBillingPolicy -ApplicationId [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Remove-SPOAppBillingPolicy removes the billing policy associated with the application. +Remove-SPOAppBillingPolicy removes the billing policy associated with the application. You must be a SharePoint Administrator to run this cmdlet. @@ -32,7 +31,7 @@ You must be a SharePoint Administrator to run this cmdlet. > To use the Remove-SPOAppBillingPolicy cmdlet, an admin must authenticate to SharePoint Online using modern authentication. > > Use the **Connect-SPOService** cmdlet shown below, which will prompt you to enter your credentials. If multi-factor authentication (MFA) is enabled, you will need to complete the MFA process (e.g., entering a verification code sent to your phone). -> +> > > `Connect-SPOService -Url https://(your-tenant)-admin.sharepoint.com` > @@ -52,9 +51,9 @@ Remove-SPOAppBillingPolicy -ApplicationId 1653hhd-87100luhw-786265gk-00asa00 ### -ApplicationID This parameter specifies the ID of the application. - + ```yaml -Type: GUID +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -66,6 +65,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOBlockedPageCreationContentType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOBlockedPageCreationContentType.md new file mode 100644 index 000000000..4c6cf542e --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOBlockedPageCreationContentType.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOBlockedPageCreationContentType + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOBlockedPageCreationContentType -ContentType [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContentType +{{ Fill ContentType Description }} + +```yaml +Type: Microsoft.SharePoint.Client.TemplateFileType +Parameter Sets: (All) +Aliases: +Accepted values: StandardPage, WikiPage, FormPage, ClientSidePage, Invalid + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md similarity index 67% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContainer.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md index 453663d37..ebed707ca 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainer.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spocontainer applicable: SharePoint Online @@ -17,10 +17,8 @@ Sends a Container to the Recycle Bin. ## SYNTAX -### ParamSet1 - -```powershell -Remove-SPOContainer [-Identity ] [] +``` +Remove-SPOContainer [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,21 +37,67 @@ You must be at least a SharePoint Online administrator to run the cmdlet. Remove-SPOContainer -Identity 423poi45-jikl-9bnm-b302-1234ghy56789 ``` -Example 1 places the Container with the `ContainerId` `423poi45-jikl-9bnm-b302-1234ghy56789` into the Recycle Bin. The Container will be permanently deleted from the Recycle Bin after 93 days unless the deleted Container is [restored](./Restore-SPODeletedContainer.md) before permanent deletion. +Example 1 places the Container with the `ContainerId` `423poi45-jikl-9bnm-b302-1234ghy56789` into the Recycle Bin. The Container will be permanently deleted from the Recycle Bin after 93 days unless the deleted Container is [restored](./Restore-SPODeletedContainer.md) before permanent deletion. ## PARAMETERS +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Use this parameter to provide the `ContainerId` of the Container to be deleted. - + ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -64,6 +108,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md similarity index 59% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContainerType.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md index 4006e2a98..80b2067fd 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerType.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spocontainertype applicable: SharePoint Online @@ -9,55 +9,113 @@ author: ShreyasSar26 ms.author: shsaravanan ms.reviewer: --- - + # Remove-SPOContainerType - + ## SYNOPSIS This cmdlet removes the container type specified from the tenant. - + ## SYNTAX - -### ParamSet1 - -```powershell -Remove-SPOContainerType -ContainerTypeId + +``` +Remove-SPOContainerType -ContainerTypeId [-Force] [-WhatIf] [-Confirm] [] ``` - + ## DESCRIPTION - + This cmdlet deletes only the trial container type in the tenant. To delete a container type in trial status, you must remove all containers of the container type first, including from the deleted container collection. To remove containers, refer to [Remove-SPOContainer](./Remove-SPOContainer.md). Once all the containers are deleted, trial container type can be deleted using this cmdlet. You must be a SharePoint Embedded Administrator to run this cmdlet. - + ## EXAMPLES - + ### Example 1 - + ```powershell Remove-SPOContainerTypeId -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604a8 ``` In Example 1, the cmdlet asks for a confirmation on the remove action and on confirmation, deletes the trial container type. Example 1 places the container with the given ID into the recycle bin. The container will be permanently deleted from the recycle bin after 93 days unless the deleted container is [restored](./Restore-SPODeletedContainer.md) before permanent deletion. - + ## PARAMETERS - + ### -ContainerTypeId - + 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: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online - + Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerUser.md new file mode 100644 index 000000000..d0336e6e5 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContainerUser.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOContainerUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOContainerUser [-ContainerId] -LoginName -Role [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContainerId +{{ Fill ContainerId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginName +{{ Fill LoginName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +{{ Fill Role Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Owner, Reader, Writer, Manager + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContentEventEmailAddresses.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentEventEmailAddresses.md similarity index 70% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContentEventEmailAddresses.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentEventEmailAddresses.md index 9fa338ae0..35db0fd56 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContentEventEmailAddresses.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentEventEmailAddresses.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spocontenteventemailaddresses applicable: SharePoint Online @@ -19,8 +19,9 @@ Removes the email addresses associated with the specified category of content ev ## SYNTAX -```powershell -Remove-SPOContentEventEmailAddresses [-Category] [-EmailAddresses] +``` +Remove-SPOContentEventEmailAddresses [-Category] [-EmailAddresses] + [] ``` ## DESCRIPTION @@ -44,12 +45,13 @@ In Example 1, the email addresses joe.doe@contoso.com and john.dow@contoso.com h Specifies the content event category. ```yaml -Type: ContentEventCategory +Type: Microsoft.SharePoint.Administration.TenantAdmin.ContentEventCategory Parameter Sets: (All) Aliases: +Accepted values: Unknown, Ransomware, HighVolumeDownload, HighVolumeDelete, HighVolumeShare Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -60,21 +62,32 @@ Accept wildcard characters: False List of comma seperated email addresses ```yaml -Type: strings +Type: System.String[] Parameter Sets: (All) +Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES ## RELATED LINKS [Get-SPOContentEventEmailAddresses](Get-SPOContentEventEmailAddresses.md) -[Set-SPOContentEventEmailAddresses](Set-SPOContentEventEmailAddresses.md) \ No newline at end of file +[Set-SPOContentEventEmailAddresses](Set-SPOContentEventEmailAddresses.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContentSecurityPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md similarity index 50% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContentSecurityPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md index 8ce6ffa81..9470712ed 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOContentSecurityPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOContentSecurityPolicy.md @@ -1,5 +1,5 @@ --- -external help file: +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/remove-spocontentsecuritypolicy applicable: SharePoint Online @@ -19,10 +19,8 @@ Removes a source from the **Content Security Policy** configuration. ## SYNTAX -### Default - -```powershell -Remove-SPOContentSecurityPolicy [-Source] +``` +Remove-SPOContentSecurityPolicy [-Source] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,7 +35,7 @@ In multi-geo environments, **Content Security Policy** configuration is unique t Source to be removed from the **Content Security Policy** configuration. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -49,10 +47,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOContentSecurityPolicy](Get-SPOContentSecurityPolicy.md) [Add-SPOContentSecurityPolicy](Add-SPOContentSecurityPolicy.md) -[Content Security Policy source values](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources) \ No newline at end of file +[Content Security Policy source values](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOCrossTenantRelationship.md similarity index 56% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantOrgRelation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOCrossTenantRelationship.md index a99cfba8d..80e4e80a6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantOrgRelation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOCrossTenantRelationship.md @@ -1,34 +1,28 @@ --- -external help file: sharepointonline.xml +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/Remove-SPOTenantOrgRelation -applicable: SharePoint Online -title: Remove-SPOTenantOrgRelation +online version: schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: --- -# Remove-SPOTenantOrgRelation -## SYNOPSIS +# Remove-SPOCrossTenantRelationship -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. +## SYNOPSIS +{{ Fill in the Synopsis }} ## SYNTAX -```powershell -Remove-SPOTenantOrgRelation [-Scenario] [-PartnerRole] [-PartnerCompanyId] [-PartnerInstanceId ] [] +``` +Remove-SPOCrossTenantRelationship [-Scenario] [-PartnerRole] + [-PartnerCrossTenantHostUrl] [] ``` ## DESCRIPTION - {{ Fill in the Description }} ## EXAMPLES ### Example 1 - ```powershell PS C:\> {{ Add example code here }} ``` @@ -37,12 +31,11 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} +### -PartnerCrossTenantHostUrl +{{ Fill PartnerCrossTenantHostUrl Description }} ```yaml -Type: Guid +Type: System.String Parameter Sets: (All) Aliases: @@ -53,28 +46,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PartnerInstanceId - -{{ Fill PartnerInstanceId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PartnerRole - {{ Fill PartnerRole Description }} ```yaml -Type: OrgRelationRole +Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole Parameter Sets: (All) Aliases: Accepted values: None, Source, Target @@ -87,11 +63,10 @@ Accept wildcard characters: False ``` ### -Scenario - {{ Fill Scenario Description }} ```yaml -Type: OrgRelationScenario +Type: Microsoft.SharePoint.Client.Administration.OrgRelationScenario Parameter Sets: (All) Aliases: Accepted values: None, MnA @@ -104,8 +79,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataAccessGovernanceInsight.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODataAccessGovernanceInsight.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataAccessGovernanceInsight.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODataAccessGovernanceInsight.md index 69d60e9af..704d86712 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataAccessGovernanceInsight.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODataAccessGovernanceInsight.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spodataaccessgovernanceinsight applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Remove-SPODataAccessGovernanceInsight schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -39,31 +39,31 @@ This command deletes the report of the given ID "28f4c550-215a-472b-a123-c11e5fa ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ReportID + +Specifies the ID of the DAG report to be removed or deleted. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportID - -Specifies the ID of the DAG report to be removed or deleted. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -75,7 +75,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -87,7 +87,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md similarity index 64% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedContainer.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md index e25a4aaf6..26b4f687a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedContainer.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spodeletedcontainer applicable: SharePoint Online @@ -18,12 +18,9 @@ Permanently deletes the specified Container from the Recycle Bin. This action ca ## SYNTAX - - -### ParamSet1 - -```powershell -Remove-SPODeletedContainer [-Identity ] [] +``` +Remove-SPODeletedContainer [-Identity] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -33,10 +30,10 @@ The `Remove-SPODeletedContainer` cmdlet permanently removes a deleted File Stora > [!IMPORTANT] > We do not generally recommend that you permanently delete Containers. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). + +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -52,17 +49,63 @@ This example removes a deleted Container with the `ContainerId` `b66f5b2e-4cbd-4 ## PARAMETERS +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity Specifies the `` of the Container to be permanently deleted. - + ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -75,11 +118,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + +## OUTPUTS + +### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Remove-SPOContainer](./Remove-SPOContainer.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md index fd1e2eeab..883b4f0d0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPODeletedSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spodeletedsite applicable: SharePoint Online @@ -18,8 +18,8 @@ Removes a SharePoint Online deleted site collection from the Recycle Bin. ## SYNTAX -```powershell -Remove-SPODeletedSite [-Confirm] -Identity [-NoWait] [-WhatIf] [] +``` +Remove-SPODeletedSite -Identity [-NoWait] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -28,7 +28,7 @@ The `Remove-SPODeletedSite` cmdlet permanently removes a SharePoint Online delet You must be at least a SharePoint administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). **Note**: As of today, the modern admin center UI does not allow permanent deletion of group connected site. The use of this cmdlet does allow the deletion, but when this occurs it does not delete the associated group, just the site. @@ -44,48 +44,48 @@ This example removes a SharePoint Online deleted site collection named [-WhatIf] [] +``` +Remove-SPOExternalUser -UniqueIDs [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -28,7 +28,7 @@ The `Remove-SPOExternalUser` cmdlet permanently removes a collection of external Users who are removed lose access to all tenant resources. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -43,32 +43,32 @@ This example removes a specific external user who has the address "someone@examp ## PARAMETERS -### -Confirm +### -UniqueIDs -Prompts you for confirmation before running the cmdlet. +Specifies an ID that can be used to identify an external user based on their Windows Live ID. ```yaml -Type: SwitchParameter +Type: System.String[] Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UniqueIDs +### -Confirm -Specifies an ID that can be used to identify an external user based on their Windows Live ID. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String[] +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -81,7 +81,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -104,6 +104,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOExternalUser](Get-SPOExternalUser.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md new file mode 100644 index 000000000..ef6863bfc --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOFontPackage.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOFontPackage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOFontPackage [-Identity] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOFontPackagePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md similarity index 63% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md index 12428fbf7..6abd35a60 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOGeoAdministrator.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spogeoadministrator applicable: SharePoint Online @@ -18,21 +18,32 @@ Removes a new SharePoint user or security Group in the current Multi-Geo Tenant. ## SYNTAX -```powershell -Remove-SPOGeoAdministrator [-LoginName] [] +### User (Default) +``` +Remove-SPOGeoAdministrator [-UserPrincipalName] [] +``` + +### Group +``` +Remove-SPOGeoAdministrator [-GroupAlias] [] +``` + +### ObjectId +``` +Remove-SPOGeoAdministrator [-ObjectId] [] ``` ## DESCRIPTION This cmdlet contains a single parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see [Cmdlet parameter sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). +For more information about how to use parameter sets, see [Cmdlet parameter sets](/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). The `Remove-SPOGeoAdministrator` cmdlet matches a user or a security group and remove the GeoAdministrator privileges in the SharePoint Organization. You must be at least a SharePoint Online administrator, and you must have a Multi-Geo Tenant to run the `Remove-SPOGeoAdministrator` cmdlet successfully. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -54,13 +65,42 @@ Same as example 1, but using the LoginName parameter explicitly. ## PARAMETERS -### -LoginName +### -GroupAlias +{{ Fill GroupAlias Description }} -It's the user Principal Name or UPN of a user. Typically the username that he uses to log in. +```yaml +Type: System.String +Parameter Sets: Group +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +{{ Fill ObjectId Description }} ```yaml -Type: String -Parameter Sets: (All) +Type: System.Guid +Parameter Sets: ObjectId +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +{{ Fill UserPrincipalName Description }} + +```yaml +Type: System.String +Parameter Sets: User Aliases: Applicable: SharePoint Online @@ -77,13 +117,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHomeSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHomeSite.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHomeSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHomeSite.md index a8089ef68..2b7ebecdc 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHomeSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHomeSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spohomesite applicable: SharePoint Online @@ -18,7 +18,7 @@ Removes the current SharePoint Online Home site setting. ## SYNTAX -```powershell +``` Remove-SPOHomeSite [] ``` @@ -42,4 +42,12 @@ This example removes the current SharePoint Online Home Site setting. This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md similarity index 60% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md index 24c98d0c5..177fe4c3f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubSiteAssociation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spohubsiteassociation applicable: SharePoint Online @@ -18,9 +18,8 @@ Removes a site from its associated hub site. ## SYNTAX -```powershell -Remove-SPOHubSiteAssociation [-Site] -[] +``` +Remove-SPOHubSiteAssociation [-Site] [] ``` ## DESCRIPTION @@ -49,14 +48,29 @@ This example removes the research site from the marketing hub site. URL of the site to remove from the hub site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubToHubAssociation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubToHubAssociation.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubToHubAssociation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubToHubAssociation.md index 4dbadc96d..708756248 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubToHubAssociation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOHubToHubAssociation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spohubtohubassociation applicable: SharePoint Online @@ -18,8 +18,8 @@ Removes the selected hub site from its parent hub. ## SYNTAX -```powershell -Remove-SPOHubToHubAssociation [-HubSiteId] [] +``` +Remove-SPOHubToHubAssociation [-HubSiteId] [] ``` ## DESCRIPTION @@ -43,14 +43,14 @@ This example removes the site with the given id from its parent Hub. Id of the Hub site to be removed from its parent Hub. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -58,4 +58,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### System.Guid + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOInformationBarriersPolicyComplianceReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOInformationBarriersPolicyComplianceReport.md new file mode 100644 index 000000000..cf6794bba --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOInformationBarriersPolicyComplianceReport.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOInformationBarriersPolicyComplianceReport + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOInformationBarriersPolicyComplianceReport -ReportID [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ReportID +{{ Fill ReportID Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOKnowledgeHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOKnowledgeHubSite.md new file mode 100644 index 000000000..e26c67634 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOKnowledgeHubSite.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOKnowledgeHubSite + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOKnowledgeHubSite [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOListDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListDesign.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOListDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListDesign.md index 8d8f30a8c..04e82b2e1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOListDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListDesign.md @@ -12,7 +12,7 @@ title: Remove-SPOListDesign # Remove-SPOListDesign ## SYNOPSIS -Removes a list design. It no longer appears in the UI for creating a new list. +Removes a list design. It no longer appears in the UI for creating a new list. ## SYNTAX @@ -21,7 +21,7 @@ Remove-SPOListDesign [-Identity] [] ``` ## DESCRIPTION -Removes a list design. It no longer appears in the UI for creating a new list. +Removes a list design. It no longer appears in the UI for creating a new list. ## EXAMPLES @@ -30,15 +30,15 @@ Removes a list design. It no longer appears in the UI for creating a new list. ```powershell PS > Remove-SPOListDesign -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ``` -This example shows how to remove a list design. +This example shows how to remove a list design. ## PARAMETERS ### -Identity -The ID of the list design to remove. +The ID of the list design to remove. ```yaml -Type: SPOListDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOListDesignPipeBind Parameter Sets: (All) Aliases: @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOListFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListFileVersionBatchDeleteJob.md similarity index 66% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOListFileVersionBatchDeleteJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListFileVersionBatchDeleteJob.md index 6f86125a3..69b06879a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOListFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOListFileVersionBatchDeleteJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spolistfileversionbatchdeletejob applicable: SharePoint Online @@ -19,8 +19,9 @@ Cancels further processing of a trim job for a document library. ## SYNTAX -```powershell -Remove-SPOListFileVersionBatchDeleteJob [-Site] [-List] [] +``` +Remove-SPOListFileVersionBatchDeleteJob [-Site] -List [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -39,31 +40,63 @@ Example 1 cancels further processing of the trim job for a document library call ## PARAMETERS +### -List + +The document library name or Id. + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Site Specifies the URL of the site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -List +### -Confirm +Prompts you for confirmation before running the cmdlet. -The document library name or Id. +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SPOListPipeBind +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -74,6 +107,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +### Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOListFileVersionBatchDeleteJobProgress](Get-SPOListFileVersionBatchDeleteJobProgress.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md similarity index 92% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md index 7f35bbe50..997773e59 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOMigrationJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spomigrationjob applicable: SharePoint Online @@ -18,7 +18,7 @@ Cmdlet to remove a previously created migration job from the specified site coll ## SYNTAX -```powershell +``` Remove-SPOMigrationJob [-TargetWebUrl] [-JobId] -Credentials [-NoLogFile] [] ``` @@ -29,7 +29,7 @@ Cmdlet to remove a previously created migration job from the specified site coll ## EXAMPLES -### -----------------------EXAMPLE----------------------------- +### Example 1 ```powershell Remove-SPOMigrationJob -JobId 4da9e777-3e38-4804-96d9-ddeebe7dfa79 -TargetUrl https://contoso.sharepoint.com/sites/TargetSite @@ -44,7 +44,7 @@ This example removes the specified migration job from the site collection " [-WhatIf] [-Confirm] [] +``` +Remove-SPOMultiGeoCompanyAllowedDataLocation [-Location] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -42,12 +42,12 @@ Removes AUS (Australia) as an allowed mutli-geo location. The Preferred Data Location (PDL) to remove. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -59,7 +59,7 @@ Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -71,12 +71,11 @@ Accept wildcard characters: False ``` ### -WhatIf - -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` +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -91,6 +90,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgAssetsLibrary.md similarity index 61% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgAssetsLibrary.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgAssetsLibrary.md index d5b65b2d8..9a784c0ed 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgAssetsLibrary.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spoorgassetslibrary applicable: SharePoint Online @@ -19,8 +19,8 @@ Removes a library that was designated as a central location for organization ass ## SYNTAX -```powershell -Remove-SPOOrgAssetsLibrary [-LibraryUrl ] [-ListId ] [] +``` +Remove-SPOOrgAssetsLibrary [-LibraryUrl ] [-ListId ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,7 +46,7 @@ Remove-SPOOrgAssetsLibrary -ListId 58454454-6546-6466-9769-646464623988 Indicates the server relative URL of the library to be removed as a central location for organization assets. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -62,7 +62,7 @@ Accept wildcard characters: False Indicates the library ID for the library to be removed as a central location for organization assets. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -73,16 +73,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Add-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/add-spoorgassetslibrary?view=sharepoint-ps) +[Add-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/add-spoorgassetslibrary) -[Set-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/set-spoorgassetslibrary?view=sharepoint-ps) +[Set-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/set-spoorgassetslibrary) -[Get-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/get-spoorgassetslibrary?view=sharepoint-ps) +[Get-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/get-spoorgassetslibrary) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md similarity index 91% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgNewsSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md index 3879eedac..e24cdbf7f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgNewsSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOOrgNewsSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spoorgnewssite applicable: SharePoint Online @@ -17,7 +17,7 @@ Removes a given site from the list of organizational news sites based on its URL ## SYNTAX -```powershell +``` Remove-SPOOrgNewsSite -OrgNewsSiteUrl [] ``` @@ -42,7 +42,7 @@ This example removes from the l The URL of a site to be marked as an organizational news site. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -58,6 +58,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOOrgNewsSite](Get-SPOOrgNewsSite.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPortalLaunchWaves.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPortalLaunchWaves.md new file mode 100644 index 000000000..50608929b --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPortalLaunchWaves.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOPortalLaunchWaves + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOPortalLaunchWaves -LaunchSiteUrl [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -LaunchSiteUrl +{{ Fill LaunchSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md index c252b910d..8745a9338 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOPublicCdnOrigin.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spopubliccdnorigin applicable: SharePoint Online @@ -18,8 +18,8 @@ Removes a given public CDN origin based on its identity (id) in your SharePoint ## SYNTAX -```powershell -Remove-SPOPublicCdnOrigin [-Identity] [-Confirm] [-WhatIf] [] +``` +Remove-SPOPublicCdnOrigin [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,37 +45,37 @@ This example returns a list of CDN origins and then removes an origin based on t ## PARAMETERS -### -Confirm +### -Identity -Prompts you for confirmation before running the cmdlet. +It's the unique identifier of the Public CDN path, it can be queried using the Cmdlet Get-SpoPublicCdnOrigins ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Identity +### -Confirm -It's the unique identifier of the Public CDN path, it can be queried using the Cmdlet Get-SpoPublicCdnOrigins +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -85,7 +85,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -101,9 +101,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### System.String + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md index 457e99dc2..f54ab5b88 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSdnProvider.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-sposdnprovider applicable: SharePoint Online @@ -18,8 +18,8 @@ Removes Software-Defined Networking (SDN) Support in your SharePoint Online tena ## SYNTAX -```powershell -Remove-SPOSdnProvider [-Confirm] [-WhatIf] [] +``` +Remove-SPOSdnProvider [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,7 +36,7 @@ Remove-SPOSdnProvider -Confirm:false This command removes the SDN support for your Online Tenant without confirmation. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```yaml Remove-SPOSdnProvider -Confirm:true -WhatIf @@ -51,7 +51,7 @@ This command will prompt for a confirmation before "simulating" that it will rem Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -69,7 +69,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -85,9 +85,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOServicePrioritizationAppRegistration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOServicePrioritizationAppRegistration.md similarity index 64% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOServicePrioritizationAppRegistration.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOServicePrioritizationAppRegistration.md index 1ece521d1..98e296edb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOServicePrioritizationAppRegistration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOServicePrioritizationAppRegistration.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Remove-SPOServicePrioritizationAppRegistration applicable: SharePoint Online @@ -20,7 +20,7 @@ Removes an app registration from service prioritization in SharePoint Online. ## SYNTAX ``` -Remove-SPOServicePrioritizationAppRegistration -AppId [] +Remove-SPOServicePrioritizationAppRegistration -AppId [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,7 +40,7 @@ This example removes the app registration with the specified AppId from service The unique identifier (GUID) of the app registration to be removed from service prioritization. This parameter is required and must be specified. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -51,8 +51,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -61,6 +92,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS @@ -75,4 +107,4 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar [Get-SPOServicePrioritizationBillingPolicies](./Get-SPOServicePrioritizationBillingPolicies.md) -[Set-SPOServicePrioritizationAppRegistration](./Set-SPOServicePrioritizationAppRegistration.md) \ No newline at end of file +[Set-SPOServicePrioritizationAppRegistration](./Set-SPOServicePrioritizationAppRegistration.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md index cf43a1ca1..ef6decb0b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-sposite applicable: SharePoint Online @@ -18,8 +18,8 @@ Sends a SharePoint Online site collection to the SharePoint Online Recycle Bin. ## SYNTAX -```powershell -Remove-SPOSite [-Confirm] -Identity [-NoWait] [-WhatIf] [] +``` +Remove-SPOSite -Identity [-NoWait] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,11 +31,11 @@ To delete a site collection permanently, first move the site collection to the R You must be at least a SharePoint Online administrator and be a site collection administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Remove-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -NoWait @@ -45,48 +45,48 @@ This example immediately removes the site collection named [] ``` @@ -43,12 +43,12 @@ This example removes the site collection app catalog from the site [] +``` +Remove-SPOSiteCollectionAppCatalogById -SiteId [] ``` ## DESCRIPTION @@ -43,7 +43,7 @@ This example removes the site collection app catalog from the site with the id ' Guid of the site collection. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -58,4 +58,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesign.md similarity index 53% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesign.md index beaa6b3f0..0eadd70f3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesign.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spositedesign applicable: SharePoint Online @@ -18,10 +18,8 @@ Removes a site design. It no longer appears in the UI for creating a new site. ## SYNTAX -```powershell - Remove-SPOSiteDesign - [-Identity] - [] +``` +Remove-SPOSiteDesign [-Identity] [] ``` ## DESCRIPTION @@ -42,16 +40,35 @@ Remove-SPOSiteDesign 21209d88-38de-4844-9823-f1f600a1179a ### -Identity +## PARAMETERS + +### -Identity + The ID of the site design to remove. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesignTask.md similarity index 67% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesignTask.md index 0bbe5f972..2ab865873 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteDesignTask.md @@ -18,10 +18,8 @@ Command to remove a scheduled site design script. ## SYNTAX -```powershell -Remove-SPOSiteDesignTask - -Identity - [] +``` +Remove-SPOSiteDesignTask [-Identity] [] ``` ## DESCRIPTION @@ -48,17 +46,30 @@ Remove-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 The ID of the site design to apply. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignTaskPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOSiteDesignTask](Get-SPOSiteDesignTask.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteFileVersionBatchDeleteJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteFileVersionBatchDeleteJob.md similarity index 67% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteFileVersionBatchDeleteJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteFileVersionBatchDeleteJob.md index 2d27c7db4..f424a8419 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteFileVersionBatchDeleteJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteFileVersionBatchDeleteJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spositefileversionbatchdeletejob applicable: SharePoint Online @@ -19,8 +19,8 @@ Stops further processing of site level trim job that is in-progress. ## SYNTAX -```powershell -Remove-SPOSiteFileVersionBatchDeleteJob [-Identity] [] +``` +Remove-SPOSiteFileVersionBatchDeleteJob [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,21 +46,62 @@ Example 1 cancels further processing of the trim job for the site collection. Specifies the URL of the site collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOSiteFileVersionBatchDeleteJobProgress](Get-SPOSiteFileVersionBatchDeleteJobProgress.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md index 9469dfd2d..717269015 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteGroup.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spositegroup applicable: SharePoint Online @@ -18,8 +18,8 @@ Removes a SharePoint Online group from a site collection. ## SYNTAX -```powershell -Remove-SPOSiteGroup -Identity -Site [] +``` +Remove-SPOSiteGroup -Site -Identity [] ``` ## DESCRIPTION @@ -28,7 +28,7 @@ Use the `Remove-SPOSiteGroup` cmdlet to remove a group from a site collection by You must be at least a SharePoint Online administrator and be a site collection administrator to run the `Remove-SPOSiteGroup` cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -47,7 +47,7 @@ This example removes a group named GroupToRemove from the site collection [] +``` +Remove-SPOSiteScript [-Identity] [] ``` ## EXAMPLES @@ -43,17 +43,28 @@ Removes a site script. The ID of the site script to remove. ```yaml -Type: SPOSiteScriptPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteSharingReportJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteSharingReportJob.md new file mode 100644 index 000000000..aa40f0cbc --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteSharingReportJob.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOSiteSharingReportJob + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOSiteSharingReportJob [-Site] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Site +{{ Fill Site Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteUserInvitations.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteUserInvitations.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteUserInvitations.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteUserInvitations.md index 0d637df51..13d936270 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteUserInvitations.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteUserInvitations.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spositeuserinvitations applicable: SharePoint Online @@ -18,8 +18,9 @@ ms.reviewer: ## SYNTAX -```powershell -Remove-SPOSiteUserInvitations [-Site] [-EmailAddress] [-CountOnly] [] +``` +Remove-SPOSiteUserInvitations [-Site] [-EmailAddress] [-CountOnly] + [] ``` ## DESCRIPTION @@ -38,17 +39,15 @@ This example removes the user with the mail address "someone@contoso.com" from t ## PARAMETERS -### -Site - -Specifies the URL of the site collection. +### -CountOnly ```yaml -Type: SpoSitePipeBind +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: 1 +Required: False +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -59,7 +58,7 @@ Accept wildcard characters: False Email Address of the user. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -70,22 +69,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CountOnly +### -Site + +Specifies the URL of the site collection. ```yaml -Type: SwitchParameter +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False -Position: 3 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## OUTPUTS + +### System.Object ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteVersionPolicyJob.md similarity index 65% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteVersionPolicyJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteVersionPolicyJob.md index b9898dcb1..524e3b5d8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteVersionPolicyJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOSiteVersionPolicyJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spositeversionpolicyjob applicable: SharePoint Online @@ -18,8 +18,9 @@ manager: seanmc Cancels further processing of version settings update on existing document libraries on the site collection. ## SYNTAX -```powershell -Remove-SPOSiteVersionPolicyJob [-Identity] [] + +``` +Remove-SPOSiteVersionPolicyJob [-Identity] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,21 +44,62 @@ Example 1 cancels further processing of the job that sets version policy for exi Specifies the URL of the site collection. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Set-SPOSite](Set-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOStorageEntity.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOStorageEntity.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOStorageEntity.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOStorageEntity.md index 7bf7fd4c8..2ec8d3b6e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOStorageEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOStorageEntity.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spostorageentity applicable: SharePoint Online @@ -19,8 +19,8 @@ This cmdlet is used to remove a value in the property bag. ## SYNTAX -```powershell -Remove-SPOStorageEntity [-Site] [-Key] [] +``` +Remove-SPOStorageEntity [-Site] [-Key] [] ``` ## DESCRIPTION @@ -39,40 +39,49 @@ This example removes the value of my custom value. ## PARAMETERS -### -Site +### -Key -URL to the tenant or site collection app catalog. +The key in the property bag that should be removed. ```yaml -Type: SpoSitePipeBind +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 0 +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Key +### -Site -The key in the property bag that should be removed. +URL to the tenant or site collection app catalog. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## OUTPUTS + +### System.Object ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md index 93b002c38..d0c782454 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantCdnOrigin.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spotenantcdnorigin applicable: SharePoint Online @@ -18,8 +18,9 @@ Removes a new origin from the Public or Private content delivery network (CDN). ## SYNTAX -```powershell -Remove-SPOTenantCdnOrigin -CdnType [-Confirm] -OriginUrl [-WhatIf] [] +``` +Remove-SPOTenantCdnOrigin -OriginUrl -CdnType [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -59,7 +60,7 @@ This example removes a recently-removed organizational assets library from a CDN Specifies the CDN type. The valid values are: Public or Private. ```yaml -Type: SPOTenantCdnType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private @@ -72,40 +73,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -OriginUrl -Prompts you for confirmation before running the cmdlet. +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. + +Any asset stored under the path provided (in the container itself or any of its subfolders) will be exposed via CDN + +Mask - Mask allows to configure a partial URL match. It must start with */, and must not include * anywhere else. I.e. an origin "*/masterpages" will expose all the assets under all the masterpages libraries, either under the tenant root (means, anywhere in the tenancy) or in the given site collection, depends on the OriginScope parameter. Equally, */masterpages/subfolder will enable items in "subfolder" and below. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OriginUrl - -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. - -Any asset stored under the path provided (in the container itself or any of its subfolders) will be exposed via CDN +### -Confirm -Mask - Mask allows to configure a partial URL match. It must start with */, and must not include * anywhere else. I.e. an origin "*/masterpages" will expose all the assets under all the masterpages libraries, either under the tenant root (means, anywhere in the tenancy) or in the given site collection, depends on the OriginScope parameter. Equally, */masterpages/subfolder will enable items in "subfolder" and below. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -118,7 +119,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingGroup.md new file mode 100644 index 000000000..13bebd3ef --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingGroup.md @@ -0,0 +1,78 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOTenantIdentityMappingGroup + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOTenantIdentityMappingGroup [-Field] [-Value] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Field +{{ Fill Field Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.TenantIdentityMappingGroupField +Parameter Sets: (All) +Aliases: +Accepted values: SourceGroupObjectId, TargetGroupObjectId, TargetGroupName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +{{ Fill Value Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingUser.md new file mode 100644 index 000000000..0e454cf65 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantIdentityMappingUser.md @@ -0,0 +1,78 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOTenantIdentityMappingUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-SPOTenantIdentityMappingUser [-Field] [-Value] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Field +{{ Fill Field Description }} + +```yaml +Type: Microsoft.SharePoint.Client.Administration.TenantIdentityMappingUserField +Parameter Sets: (All) +Aliases: +Accepted values: SourceUserKey, TargetUserPuid, TargetUserUpn, TargetUserEmail + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +{{ Fill Value Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantRenameSitePrioritization.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantRenameSitePrioritization.md similarity index 93% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantRenameSitePrioritization.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantRenameSitePrioritization.md index 6a7f616d9..87f62d100 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantRenameSitePrioritization.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantRenameSitePrioritization.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spotenantrenamesiteprioritization applicable: SharePoint Online @@ -43,7 +43,7 @@ This example removes the 'projectx' site from the prioritized list of sites with Specifies the full site URL of the site you wish to prioritize. This can be either a OneDrive for Business or SharePoint Online site. Only a site that is currently prioritized can be removed. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -56,7 +56,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantRestrictedSearchAllowedList.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantRestrictedSearchAllowedList.md new file mode 100644 index 000000000..41b0f664b --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantRestrictedSearchAllowedList.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Remove-SPOTenantRestrictedSearchAllowedList + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### SitesList +``` +Remove-SPOTenantRestrictedSearchAllowedList -SitesList + [] +``` + +### SitesListFileUrl +``` +Remove-SPOTenantRestrictedSearchAllowedList -SitesListFileUrl [-ContainsHeader ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContainsHeader +{{ Fill ContainsHeader Description }} + +```yaml +Type: System.Boolean +Parameter Sets: SitesListFileUrl +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SitesList +{{ Fill SitesList Description }} + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: SitesList +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SitesListFileUrl +{{ Fill SitesListFileUrl Description }} + +```yaml +Type: System.String +Parameter Sets: SitesListFileUrl +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantSyncClientRestriction.md similarity index 96% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantSyncClientRestriction.md index 1505cb3da..3d9d60a5b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantSyncClientRestriction.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spotenantsyncclientrestriction applicable: SharePoint Online @@ -18,7 +18,7 @@ Disables the feature for the tenancy. ## SYNTAX -```powershell +``` Remove-SPOTenantSyncClientRestriction [] ``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTheme.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTheme.md index 81bc3c292..68c462a0e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTheme.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spotheme applicable: SharePoint Online @@ -18,7 +18,7 @@ Removes a theme from the theme gallery. ## SYNTAX -```powershell +``` Remove-SPOTheme [-Identity] [-WhatIf] [-Confirm] [] ``` @@ -38,35 +38,35 @@ Remove-SPOTheme -Identity "Custom Cyan" ## PARAMETERS -### -Confirm +### -Identity -Prompts you for confirmation before running the cmdlet. +Name of the theme to remove. ```yaml -Type: SwitchParameter +Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind Parameter Sets: (All) -Aliases: cf +Aliases: Name -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Identity +### -Confirm -Name of the theme to remove. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SpoThemePipeBind +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: Name +Aliases: cf -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,7 +76,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -89,7 +89,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md index a70296baf..bd522d194 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUser.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spouser applicable: SharePoint Online @@ -18,15 +18,15 @@ Removes a user or a security group from a site collection or a group. ## SYNTAX -```powershell -Remove-SPOUser [-Group ] -LoginName -Site [] +``` +Remove-SPOUser -Site -LoginName [-Group ] [] ``` ## DESCRIPTION You must be at least a SharePoint Online administrator and be a site collection administrator to run the `Remove-SPOUser` cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -45,7 +45,7 @@ This example removes a user who has the email address joe.healy@contoso.com from Specifies the group to remove the user from. If not specified, the cmdlet removes the user from all groups. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -62,7 +62,7 @@ Accept wildcard characters: False Specifies the user name. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -79,7 +79,7 @@ Accept wildcard characters: False Specifies the site collection to remove the user from. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -103,6 +103,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOUser](Get-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md index 1f69c76a9..e908ae310 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserInfo.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spouserinfo applicable: SharePoint Online @@ -15,6 +15,12 @@ ms.reviewer: ## SYNOPSIS Do not use. +## SYNTAX + +``` +Remove-SPOUserInfo -LoginName -Site [-RedactName ] [] +``` + ## DESCRIPTION @@ -29,7 +35,7 @@ Do not use. Do not use. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -41,12 +47,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RedactName +{{ Fill RedactName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Site Do not use. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -64,8 +85,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md index bbe1085de..2f952cfda 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOUserProfile.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/remove-spouserprofile applicable: SharePoint Online @@ -19,8 +19,8 @@ Remove user profile from the tenant. ## SYNTAX -```powershell -Remove-SPOUserProfile -LoginName [] +``` +Remove-SPOUserProfile -LoginName [-UserId ] [] ``` ## DESCRIPTION @@ -32,7 +32,7 @@ Can be used to remove the SharePoint user profile from the tenant. ## EXAMPLES -### ------------ Example 1 -------------------- +### Example 1 ```powershell Remove-SPOUserProfile -LoginName joe.healy@contoso.com @@ -47,7 +47,7 @@ Example 1 removes a user who has the e-mail address joe.healy@contoso.com from t Specifies the login name of the user which user profile is deleted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -59,14 +59,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserId +{{ Fill UserId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md index 1a1616fe0..ebf622556 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Repair-SPOSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/repair-sposite applicable: SharePoint Online @@ -18,8 +18,8 @@ Checks and repairs the site collection and its contents. ## SYNTAX -```powershell -Repair-SPOSite [-Confirm] -Identity [-RuleId ] [-RunAlways] [-WhatIf] +``` +Repair-SPOSite -Identity [-RuleId ] [-RunAlways] [-WhatIf] [-Confirm] [] ``` @@ -34,11 +34,11 @@ Tests without repair mode can be initiated by running the `Test-SPOSite` cmdlet. You must be at least a SharePoint administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Repair-SPOSite https://contoso.sharepoint.com/sites/marketing @@ -46,7 +46,7 @@ Repair-SPOSite https://contoso.sharepoint.com/sites/marketing This example runs all the site collection health checks in repair mode on the site collection. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Repair-SPOSite https://contoso.sharepoint.com/sites/marketing -RuleID "ee967197-ccbe-4c00-88e4-e6fab81145e1" @@ -56,29 +56,12 @@ This example runs the Missing Galleries Check rule in repair mode on the [] +``` +Request-SPOPersonalSite -UserEmails [-NoWait] [] ``` ## DESCRIPTION The `Request-SPOPersonalSite` cmdlet requests that the users specified be enqueued so that a Personal Site be created for each. The actual Personal site is created by a Timer Job later. If the user already has a Personal Site created, the request for creation for the user will be silently ignored. -Note: -- You must specify a string array of user logins that contains one or more valid user email (logins) and cannot contain any empty fields. The command will stop if it encounters any empty strings in the array. A maximum of 200 users can be specified. -- The actor executing this cmdlet must be at least assigned the SharePoint Online administrator role and have been assigned a SharePoint Online license to be able to provision the OneDrive for Business sites. The users who the sites will be provisioned for must also have a SharePoint license assigned. +Note: +- You must specify a string array of user logins that contains one or more valid user email (logins) and cannot contain any empty fields. The command will stop if it encounters any empty strings in the array. A maximum of 200 users can be specified. +- The actor executing this cmdlet must be at least assigned the SharePoint Online administrator role and have been assigned a SharePoint Online license to be able to provision the OneDrive for Business sites. The users who the sites will be provisioned for must also have a SharePoint license assigned. - This cmdlet is NOT OneDrive Multi-Geo aware. If you need to request Personal Sites for Multi-Geo enabled tenants, you must run this cmdlet for users in the region their data is to be hosted in. To retrieve users with a specific PDL, use the following sample: `Get-MSOLUser | Where {$_.PreferredDataLocation -eq "EUR"}`. For more information and other examples, see [Pre-provision OneDrive for users in your organization](/sharepoint/pre-provision-accounts). ## EXAMPLES -### ----------------------EXAMPLE 1----------------------- +### EXAMPLE 1 ```powershell $emails = "user1@contoso.com", "user2@contoso.com" @@ -45,7 +45,7 @@ Request-SPOPersonalSite -UserEmails $emails This example requests that two users to be enqueued for the creation of a Personal Site. -### ----------------------EXAMPLE 2----------------------- +### EXAMPLE 2 ```powershell Request-SPOPersonalSite -UserEmails $emails @@ -60,7 +60,7 @@ This example requests that many users to be queued for the creation of a Persona Continues without the status being polled. Polling the action can slow it's progress if lots of user emails are specified. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -79,7 +79,7 @@ Specifies one or more user logins to be enqueued for the creation of a Personal > If you're pre-provisioning OneDrive for a large number of users, it might take multiple days for the OneDrive locations to be created. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md index 0e31e9758..4a52a5c3d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Request-SPOUpgradeEvaluationSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/request-spoupgradeevaluationsite applicable: SharePoint Online @@ -18,8 +18,8 @@ Requests to create a copy of an existing site collection for the purposes of val ## SYNTAX -```powershell -Request-SPOUpgradeEvaluationSite [-Confirm] -Identity [-NoEmail] [-NoUpgrade] [-WhatIf] +``` +Request-SPOUpgradeEvaluationSite -Identity [-NoUpgrade] [-NoEmail] [-WhatIf] [-Confirm] [] ``` @@ -32,11 +32,11 @@ Instead, it is scheduled to occur in the background when it causes the least eff You must be at least a SharePoint administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Request-SPOUpgradeEvaluationSite https://contoso.sharepoint.com/sites/marketing @@ -44,7 +44,7 @@ Request-SPOUpgradeEvaluationSite https://contoso.sharepoint.com/sites/marketing Example 1 requests a site upgrade evaluation for the marketing site using the default options of sending an email message and automatically trying to upgrade the evaluation site. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Request-SPOUpgradeEvaluationSite https://contoso.sharepoint.com/sites/marketing -NoEmail $true -NoUpgrade $true @@ -54,46 +54,46 @@ This example requests a site upgrade evaluation for the marketing site -PrimaryKeyName -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName -SecondaryKeyVersion [] +### BYOK_MultipleParameters +``` +Restore-SPODataEncryptionPolicy -PrimaryKeyVaultName -PrimaryKeyName + -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName + -SecondaryKeyVersion [] +``` + +### BYOK_Uri +``` +Restore-SPODataEncryptionPolicy -PrimaryKeyVaultUri -SecondaryKeyVaultUri [] ``` ## DESCRIPTION Use the cmdlet to restore customer encryption status for your geo tenant when in recovery mode. -For more information, see [Controlling your data in Office 365 using Customer Key](https://learn.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) +For more information, see [Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) ## EXAMPLES @@ -39,13 +47,13 @@ This example restores the DEP used with SharePoint Online and OneDrive for Busin ## PARAMETERS -### -PrimaryKeyVaultName +### -PrimaryKeyName -The name of the primary key vault. +The name of the primary key. ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -55,13 +63,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryKeyName +### -PrimaryKeyVaultName -The name of the primary key. +The name of the primary key vault. ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -71,13 +79,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PrimaryKeyVaultUri +{{ Fill PrimaryKeyVaultUri Description }} + +```yaml +Type: System.Uri +Parameter Sets: BYOK_Uri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PrimaryKeyVersion The version of the primary key. ```yaml -Type: Guid -Parameter Sets: (All) +Type: System.Guid +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -87,13 +110,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryKeyVaultName +### -SecondaryKeyName -The name of the secondary key vault. +The name of the secondary key. ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -103,13 +126,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryKeyName +### -SecondaryKeyVaultName -The name of the secondary key. +The name of the secondary key vault. ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -119,13 +142,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SecondaryKeyVaultUri +{{ Fill SecondaryKeyVaultUri Description }} + +```yaml +Type: System.Uri +Parameter Sets: BYOK_Uri +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SecondaryKeyVersion The version of the secondary key. ```yaml -Type: Guid -Parameter Sets: (All) +Type: System.Guid +Parameter Sets: BYOK_MultipleParameters Aliases: Applicable: SharePoint Online Required: True @@ -136,7 +174,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## OUTPUTS + +### System.Object ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedContainer.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md index 5e1262954..6a5af8567 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedContainer.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/restore-spodeletedcontainer applicable: SharePoint Online @@ -14,14 +14,12 @@ ms.reviewer: ## SYNOPSIS -Recovers a deleted Container from the Recycle Bin. +Recovers a deleted Container from the Recycle Bin. ## SYNTAX -### ParamSet1 - -```powershell -Restore-SPODeletedContainer [-Identity ] [] +``` +Restore-SPODeletedContainer [-Identity] [] ``` ## DESCRIPTION @@ -47,15 +45,15 @@ Example 1 restores the Container with `ContainerId` `b66f5b2e-4cbd-4754-9ad3-829 ### -Identity Use this parameter to specify the `ContainerId` of the deleted container to be restored. - + ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: Yes -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -65,11 +63,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPODeletedContainer](./Get-SPODeletedContainer.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md index 8ea10be57..1f6592a9b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Restore-SPODeletedSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/restore-spodeletedsite applicable: SharePoint Online @@ -18,7 +18,7 @@ Restores a SharePoint Online deleted site collection from the Recycle Bin. ## SYNTAX -```powershell +``` Restore-SPODeletedSite -Identity [-NoWait] [] ``` @@ -26,11 +26,11 @@ Restore-SPODeletedSite -Identity [-NoWait] [ You must be at least a SharePoint administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### ----------------------EXAMPLE----------------------- +### EXAMPLE ```powershell Restore-SPODeletedSite -Identity https://contoso.sharepoint.com/sites/arecycledsite @@ -45,7 +45,7 @@ This example restores a SharePoint Online deleted site collection named " -Principals [] +``` +Revoke-SPOHubSiteRights [-Identity] -Principals [] ``` ## DESCRIPTION @@ -47,15 +47,15 @@ This example shows how to revoke rights so that Nestor can no longer join sites URL of the hub site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -64,7 +64,7 @@ Accept wildcard characters: False One or more principals to revoke the permissions for. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -77,5 +77,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOSiteDesignRights.md similarity index 63% rename from sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOSiteDesignRights.md index 3b859678d..d7227f8b2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOSiteDesignRights.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/revoke-spositedesignrights applicable: SharePoint Online @@ -18,8 +18,8 @@ Revokes rights for specified principals from a site design. ## SYNTAX -```powershell -Revoke-SPOSiteDesignRights [-Identity] -Principals [] +``` +Revoke-SPOSiteDesignRights [-Identity] -Principals [] ``` ## DESCRIPTION @@ -44,14 +44,14 @@ Revoke-SPOSiteDesignRights 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` The ID of the site design from which to revoke rights. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -60,7 +60,7 @@ Accept wildcard characters: False One or more principals to revoke rights on the specified site design. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -71,10 +71,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOTenantServicePrincipalPermission.md similarity index 70% rename from sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOTenantServicePrincipalPermission.md index 52fa82876..e8566b665 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOTenantServicePrincipalPermission.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/revoke-spotenantserviceprincipalpermission applicable: SharePoint Online @@ -17,10 +17,8 @@ Revokes a permission that was previously granted to the "SharePoint Online Clien ## SYNTAX -### Default - -```powershell -Revoke-SPOTenantServicePrincipalPermission [-ObjectId] [-Confirm] [] +``` +Revoke-SPOTenantServicePrincipalPermission -ObjectId [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,7 +27,7 @@ Revokes a permission that was previously granted to the "SharePoint Online Clien ## EXAMPLES -### ------------------EXAMPLE 1------------------ +### EXAMPLE 1 ```powershell $grants = Get-SPOTenantServicePrincipalPermissionGrants @@ -51,11 +49,15 @@ If there is no permission with those properties, then no revoke action will be t The Object ID of the permission grant to revoke ```yaml -Type: string +Type: System.String +Parameter Sets: (All) +Aliases: Required: True Position: Named +Default value: None Accept pipeline input: False +Accept wildcard characters: False ``` ### -Confirm @@ -63,10 +65,26 @@ Accept pipeline input: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + Required: False Position: Named Default value: None @@ -75,5 +93,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md similarity index 91% rename from sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md index 97a1fa61e..b9b8f9632 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Revoke-SPOUserSession.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/revoke-spousersession applicable: SharePoint Online @@ -18,8 +18,8 @@ Provides IT administrators the ability to invalidate a particular users' O365 se ## SYNTAX -```powershell -Revoke-SPOUserSession [-User] [-Confirm] [-WhatIf] [] +``` +Revoke-SPOUserSession [-User] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -60,39 +60,39 @@ This example signs out user1 in the Contoso tenancy from all devices. Revoke-SPOUserSession -User user1@contoso.com -Confirm:$false ``` -This example signs out user1 in the Contoso tenancy from all devices without prompting for confirmation. +This example signs out user1 in the Contoso tenancy from all devices without prompting for confirmation. ## PARAMETERS -### -Confirm +### -User -Prompts you for confirmation before running the cmdlet. +Specifies a user name. For example, user1@contoso.com ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -User +### -Confirm -Specifies a user name. For example, user1@contoso.com +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -104,7 +104,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplication.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md similarity index 90% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplication.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md index 38bfb2ec5..6417dc282 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplication.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplication.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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 @@ -27,9 +27,9 @@ Set-SPOApplication [-OwningApplicationId] [[-SharingCapability] ] -[[–SharingCapability] ] +Set-SPOApplication +[[-OwningApplicationId] ] +[[–SharingCapability] ] [[-OverrideTenantSharingCapability] ] [[-CopilotEmbeddedChatHosts] ] ``` @@ -40,11 +40,11 @@ Set-SPOApplication You must be a SharePoint Embedded Administrator to run this cmdlet. -> [!NOTE] +> [!NOTE] > The OwningApplicationId for Microsoft Loop is `a187e399-0c36-4b98-8f04-1edc167a0996`. > The OwningApplicationId for Microsoft Designer is `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`. -To invite people outside your organization, please make sure [Microsoft Entra B2B](/sharepoint/sharepoint-azureb2b-integration) is enabled. +To invite people outside your organization, please make sure [Microsoft Entra B2B](/sharepoint/sharepoint-azureb2b-integration) is enabled. ## EXAMPLES @@ -75,7 +75,7 @@ This example demonstrates how to enable file sharing within the SharePoint Embed ### Example 4 ```powershell -Set-SPOApplication -OwningApplicationId 423poi45 -CopilotEmbeddedChatHosts "http://localhost:3000 https://contoso.sharepoint.com https://fabrikam.com" +Set-SPOApplication -OwningApplicationId 423poi45 -CopilotEmbeddedChatHosts "https://localhost:3000 https://contoso.sharepoint.com https://fabrikam.com" ``` This example sets the host URLs for the application with Id 423poi45. @@ -83,7 +83,7 @@ This example sets the host URLs for the application with Id 423poi45. ### -CopilotEmbeddedChatHosts -This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience. This will always be a subset of permissible URLs set by the application's developer. To check the list of permissible URLs, use the `Get-SPOApplication` cmdlet. +This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience. This will always be a subset of permissible URLs set by the application's developer. To check the list of permissible URLs, use the `Get-SPOApplication` cmdlet. ```yaml Type: System.Collections.Generic.List`1[System.String] @@ -97,12 +97,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OverrideTenantSharingCapability + +This setting allows the application to independently set its sharing capabilities, overriding the tenant-level settings of SharePoint Online. Options: + +- False (default) - The application follows the tenant-level sharing capability +- True - The application's sharing settings are independent of the tenant level sharing capability + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OwningApplicationId This parameter specifies the ID of the SharePoint Embedded application. - + ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -118,7 +137,7 @@ Accept wildcard characters: False Determines what level of sharing is available for the SharePoint Embedded Application. -The valid values are: +The valid values are: - ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. - Disabled - External user sharing (share by email) and guest link sharing are both disabled. @@ -128,7 +147,7 @@ The valid values are: The default setting is None, meaning the application follows the SharePoint Online tenant-level sharing settings. Use the `Get-SPOTenant` cmdlet to view these settings. ```yaml -Type: SharingCapabilities +Type: Microsoft.Online.SharePoint.TenantManagement.SharingCapabilities Parameter Sets: (All) Aliases: Accepted values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly @@ -140,27 +159,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideTenantSharingCapability +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). -This setting allows the application to independently set its sharing capabilities, overriding the tenant-level settings of SharePoint Online. Options: +## INPUTS -- False (default) - The application follows the tenant-level sharing capability -- True - The application's sharing settings are independent of the tenant level sharing capability +### None -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: +## OUTPUTS -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### System.Object -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplicationPermission.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplicationPermission.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md index a81b76000..8e59e56bd 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplicationPermission.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOApplicationPermission.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spoapplicationpermission applicable: SharePoint @@ -18,19 +18,16 @@ Manages permissions for a guest application to access a SharePoint Embedded appl ## SYNTAX - -### ParamSet1 - -```powershell -Set-SPOApplicationPermission -[[-OwningApplicationId] ] [[-ApplicationId] ] [[-PermissionAppOnly] ] [[-PermissionDelegated] ] -``` +``` +Set-SPOApplicationPermission [-OwningApplicationId] [-GuestApplicationId] + [-PermissionAppOnly] [[-PermissionDelegated] ] [] +``` ## DESCRIPTION -The `Set-SPOApplicationPermission` cmdlet manages permissions for a guest application's access to a SharePoint Embedded application. This includes adding, updating, and deleting guest application permissions. A guest application is defined as any application within the enterprise applications of the owning tenant. +The `Set-SPOApplicationPermission` cmdlet manages permissions for a guest application's access to a SharePoint Embedded application. This includes adding, updating, and deleting guest application permissions. A guest application is defined as any application within the enterprise applications of the owning tenant. -You must be a SharePoint Administrator to run this cmdlet. For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +You must be a SharePoint Administrator to run this cmdlet. For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). > [!NOTE] > Only app-only permissions are supported for guest applications accessing SharePoint Embedded applications. Delegated permissions are not supported and are default set to `None`. @@ -59,39 +56,39 @@ Example 2 gives the guest application with ID `12345678-1234-1234-abcd-abcdefghi Set-SPOApplicationPermission -OwningApplicationId 5e2795e3-ce8c-4cfb-b302-35fe5cd01597 -ApplicationId 12345678-1234-1234-abcd-abcdefghijkl -PermissionAppOnly None -PermissionDelegated None ``` -Example 3 sets guest application permissions to None for the guest application with ID `12345678-1234-1234-abcd-abcdefghijkl`. This has deleted previous permissions for that guest application to access owning application of `a187e399-0c36-4b98-8f04-1edc167a0996`. +Example 3 sets guest application permissions to None for the guest application with ID `12345678-1234-1234-abcd-abcdefghijkl`. This has deleted previous permissions for that guest application to access owning application of `a187e399-0c36-4b98-8f04-1edc167a0996`. ## PARAMETERS -### -OwningApplicationId +### -ApplicationId -Use this parameter to specify the Owning Application where guest application access is granted. +Use this parameter to specify the guest application ID. A guest application is any application within the tenant's enterprise applications. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId +### -OwningApplicationId -Use this parameter to specify the guest application ID. A guest application is any application within the tenant's enterprise applications. +Use this parameter to specify the Owning Application where guest application access is granted. ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Required: True -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -102,42 +99,52 @@ Accept wildcard characters: False Use this parameter to specify the app-only permissions of the guest application. ```yaml -Type: String +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -``` +``` ### -PermissionDelegated This parameter specifies delegated permissions which are not supported for guest applications at this time. ```yaml -Type: String +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -``` +``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES ## RELATED LINKS [Get-SPOApplication](./Get-SPOApplication.md) + [Set-SPOApplication](./Set-SPOApplication.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBlockedPageCreationContentType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBlockedPageCreationContentType.md new file mode 100644 index 000000000..f6a212b74 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBlockedPageCreationContentType.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOBlockedPageCreationContentType + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOBlockedPageCreationContentType -ContentType [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContentType +{{ Fill ContentType Description }} + +```yaml +Type: Microsoft.SharePoint.Client.TemplateFileType +Parameter Sets: (All) +Aliases: +Accepted values: StandardPage, WikiPage, FormPage, ClientSidePage, Invalid + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBrowserIdleSignOut.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBrowserIdleSignOut.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBrowserIdleSignOut.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBrowserIdleSignOut.md index b2ea0aef7..5c63d60aa 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBrowserIdleSignOut.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBrowserIdleSignOut.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spobrowseridlesignout applicable: SharePoint Online @@ -18,8 +18,9 @@ Sets the current configuration values for Idle session sign-out. ## SYNTAX -```powershell -Set-SPOBrowserIdleSignOut [-Enabled] [[-WarnAfter] ] [[-SignOutAfter] ] [] +``` +Set-SPOBrowserIdleSignOut -Enabled [-WarnAfter ] [-SignOutAfter ] + [] ``` ## DESCRIPTION @@ -51,7 +52,7 @@ This example enables the browser idle sign-out policy, sets a warning at 45 minu Enables the browser idle sign-out policy ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -66,24 +67,24 @@ Accept wildcard characters: False Specifies a time interval. This parameter is used to specify a time value for **Get-SPOBrowserIdleSignOut** parameters such as *SignOutAfter*. -Specify the time interval in the following format: +Specify the time interval in the following format: \[-\]D.H:M:S.F -where: +where: -- D = Days (0 to 10675199) -- H = Hours (0 to 23) -- M = Minutes (0 to 59) -- S = Seconds (0 to 59) +- D = Days (0 to 10675199) +- H = Hours (0 to 23) +- M = Minutes (0 to 59) +- S = Seconds (0 to 59) - F = Fractions of a second (0 to 9999999) ```yaml -Type: TimeSpan +Type: System.TimeSpan Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -94,24 +95,24 @@ Accept wildcard characters: False Specifies a time interval. This parameter is used to specify a time value for **Get-SPOBrowserIdleSignOut** parameters such as *WarnAfter*. -Specify the time interval in the following format: +Specify the time interval in the following format: \[-\]D.H:M:S.F -where: +where: -- D = Days (0 to 10675199) -- H = Hours (0 to 23) -- M = Minutes (0 to 59) -- S = Seconds (0 to 59) +- D = Days (0 to 10675199) +- H = Hours (0 to 23) +- M = Minutes (0 to 59) +- S = Seconds (0 to 59) - F = Fractions of a second (0 to 9999999) ```yaml -Type: TimeSpan +Type: System.TimeSpan Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -120,7 +121,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInDesignPackageVisibility.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInDesignPackageVisibility.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInDesignPackageVisibility.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInDesignPackageVisibility.md index f15d5e4c8..5023f1117 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInDesignPackageVisibility.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInDesignPackageVisibility.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spobuiltindesignpackagevisibility applicable: SharePoint Online @@ -18,13 +18,14 @@ Sets the visibility of the available built-in Design Packages at moment of site ## SYNTAX -```powershell -Set-SPOBuiltInDesignPackageVisibility [-IsVisible] [-DesignPackage] [] +``` +Set-SPOBuiltInDesignPackageVisibility -IsVisible -DesignPackage + [] ``` ## DESCRIPTION -Sets the visibility of the available built-in Design Packages. For more information, see [Moving from Publishing sites to Communication sites](https://learn.microsoft.com/sharepoint/publishing-sites-classic-to-modern-experience) +Sets the visibility of the available built-in Design Packages. For more information, see [Moving from Publishing sites to Communication sites](/sharepoint/publishing-sites-classic-to-modern-experience) ## EXAMPLES @@ -47,7 +48,7 @@ Name of the design package, available names are - TeamSite ```yaml -Type: DesignPackageType +Type: Microsoft.SharePoint.Administration.DesignPackageType Parameter Sets: (All) Aliases: Accepted values: None, Topic, Showcase, Blank, TeamSite @@ -64,7 +65,7 @@ Accept wildcard characters: False Determines if the design package is visible ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Required: True @@ -76,7 +77,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInFontPackageSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInFontPackageSettings.md similarity index 51% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInFontPackageSettings.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInFontPackageSettings.md index dbcae00e1..abf7f29cb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInFontPackageSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInFontPackageSettings.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spobuiltinfontpackagesettings applicable: SharePoint Online @@ -18,8 +18,8 @@ Use this cmdlet to set settings of [built-in font packages](/sharepoint/brand-ce ## SYNTAX -```powershell -Set-SPOBuiltInFontPackageSettings [-HideBuiltInFontPackages] +``` +Set-SPOBuiltInFontPackageSettings [-HideBuiltInFontPackages ] [] ``` ## DESCRIPTION @@ -39,8 +39,31 @@ This example sets the built-in font packages to be hidden from SharePoint sites. ### -HideBuiltInFontPackages -Hide built in font packages from SharePoint sites if this value is true. +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### [System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089] + +## OUTPUTS + +### System.Object + +## NOTES ## RELATED LINKS -- [Get-SPOBuiltInFontPackageSettings](./Get-SPOBuiltInFontPackageSettings.md) \ No newline at end of file +- [Get-SPOBuiltInFontPackageSettings](./Get-SPOBuiltInFontPackageSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInSiteTemplateSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md similarity index 75% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInSiteTemplateSettings.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md index bb759e46b..1cdd3a578 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInSiteTemplateSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOBuiltInSiteTemplateSettings.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-SPOBuiltInSiteTemplateSettings applicable: SharePoint Online @@ -14,28 +14,29 @@ ms.reviewer: ## SYNOPSIS -Sets all or specific Microsoft-provided SharePoint site templates to be displayed or hidden in the site template gallery in your tenant. All site templates are displayed by default. +Sets all or specific Microsoft-provided SharePoint site templates to be displayed or hidden in the site template gallery in your tenant. All site templates are displayed by default. ## SYNTAX -```powershell -Set-SPOBuiltInSiteTemplateSettings -Identity -IsHidden +``` +Set-SPOBuiltInSiteTemplateSettings [-Identity] [-IsHidden ] + [] ``` ## DESCRIPTION -The `Set-SPOBuiltInSiteTemplateSettings` cmdlet sets a specific Microsoft-provided SharePoint site templates to be displayed or hidden in the site template gallery in your tenant. +The `Set-SPOBuiltInSiteTemplateSettings` cmdlet sets a specific Microsoft-provided SharePoint site templates to be displayed or hidden in the site template gallery in your tenant. All site templates are displayed by default. -| Team site templates | Template ID | +| Team site templates | Template ID | | :------------------- | :------------------- | -| Event planning | 9522236e-6802-4972-a10d-e98dc74b3344 | -| Project management | f0a3abf4-afe8-4409-b7f3-484113dee93e| -| Training and courses | 695e52c9-8af7-4bd3-b7a5-46aca95e1c7e | -| Training and development team | 64aaa31e-7a1e-4337-b646-0b700aa9a52c | -| Team collaboration | c8b3137a-ca4c-48a9-b356-a8e7987dd693 | -| Retail management | e4ec393e-da09-4816-b6b2-195393656edd | +| Event planning | 9522236e-6802-4972-a10d-e98dc74b3344 | +| Project management | f0a3abf4-afe8-4409-b7f3-484113dee93e| +| Training and courses | 695e52c9-8af7-4bd3-b7a5-46aca95e1c7e | +| Training and development team | 64aaa31e-7a1e-4337-b646-0b700aa9a52c | +| Team collaboration | c8b3137a-ca4c-48a9-b356-a8e7987dd693 | +| Retail management | e4ec393e-da09-4816-b6b2-195393656edd |
@@ -63,15 +64,15 @@ You can hide all templates by specifying an empty ID of "00000000-0000-0000-0000 > - All site templates are displayed by default. [Learn more](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398) about SharePoint site templates > - You must have SharePoint admin credentials (or higher) to use SharePoint PowerShell. > - The minimum SharePoint PowerShell version required is 16.0.21610.12000. -> - For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +> - For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). -## EXAMPLES +## EXAMPLES ### Example 1: Hide a template -This example hides the Department template from the site template gallery. +This example hides the Department template from the site template gallery. ```powershell Set-SPOBuiltInSiteTemplateSettings -Identity "73495f08-0140-499b-8927-dd26a546f26a" -IsHidden $true @@ -79,7 +80,7 @@ Set-SPOBuiltInSiteTemplateSettings -Identity "73495f08-0140-499b-8927-dd26a546f2 ### Example 2: Display a template that's been hidden -This example displays the Department template in the site template gallery. Note all site templates are displayed by default, so this is most relevant if a template has been hidden before. +This example displays the Department template in the site template gallery. Note all site templates are displayed by default, so this is most relevant if a template has been hidden before. ```powershell Set-SPOBuiltInSiteTemplateSettings -Identity "73495f08-0140-499b-8927-dd26a546f26a" -IsHidden $false @@ -87,7 +88,7 @@ Set-SPOBuiltInSiteTemplateSettings -Identity "73495f08-0140-499b-8927-dd26a546f2 ### Example 3: Hide all templates from Microsoft -This example hides all built-in templates from the site template gallery. +This example hides all built-in templates from the site template gallery. ```powershell Set-SPOBuiltInSiteTemplateSettings -Identity "00000000-0000-0000-0000-000000000000" -IsHidden $true @@ -98,37 +99,50 @@ Set-SPOBuiltInSiteTemplateSettings -Identity "00000000-0000-0000-0000-0000000000 ## PARAMETERS ### -Identity - -Specifies the ID for the site template you wish to change. - + +Specifies the ID for the site template you wish to change. + ```yaml -Type: +Type: Microsoft.Online.SharePoint.PowerShell.SPOBuiltInSiteTemplateSettingsPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -IsHidden - + Specifies whether the site template is hidden ($true) or displayed ($false). All site templates are displayed by default. ```yaml -Type: SwitchParameter +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOBuiltInSiteTemplateSettingsPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOBuiltInSiteTemplateSettings](Get-SPOBuiltInSiteTemplateSettings.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainer.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md similarity index 76% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainer.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md index 312c588ae..08d9681f1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainer.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainer.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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 @@ -19,49 +19,46 @@ Sets or updates one or more property values for a container in SharePoint Embedd ## SYNTAX ### ParamSet1 +``` +Set-SPOContainer [-Identity] [[-SensitivityLabel] ] [-WhatIf] [-Confirm] + [] +``` -```powershell +### BlockDownloadPolicy +``` Set-SPOContainer [-Identity] [-BlockDownloadPolicy ] - [-ExcludeBlockDownloadPolicyContainerOwners ] [-ReadOnlyForBlockDownloadPolicy ] [] + [-ExcludeBlockDownloadPolicyContainerOwners ] [-ReadOnlyForBlockDownloadPolicy ] [-WhatIf] + [-Confirm] [] ``` ### ParamSet2 +``` +Set-SPOContainer [-Identity] [-RemoveLabel] [-WhatIf] [-Confirm] [] +``` -```powershell +### ConditionalAccess +``` Set-SPOContainer [-Identity] [-ConditionalAccessPolicy ] [-LimitedAccessFileType ] [-AllowEditing ] - [-ReadOnlyForUnmanagedDevices ] [-AuthenticationContextName ] [] + [-ReadOnlyForUnmanagedDevices ] [-AuthenticationContextName ] [-WhatIf] [-Confirm] + [] ``` -### ParamSet3 - -```powershell -Set-SPOContainer [-Identity] [[-SensitivityLabel] ] [] -``` - - -### ParamSet4 - -```powershell -Set-SPOContainer [-Identity] [-RemoveLabel] [] +### AllowDenyDomain ``` - -### ParamSet5 - -```powershell Set-SPOContainer [-Identity] [-SharingDomainRestrictionMode ] [-SharingAllowedDomainList ] - [-SharingBlockedDomainList ] [] + [-SharingBlockedDomainList ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -For any parameters that are passed in, the `Set-SPOContainer` cmdlet sets or updates the setting for the active container identified by the parameter `Identity`. The cmdlet throws an error if the identity of an archived container is provided. +For any parameters that are passed in, the `Set-SPOContainer` cmdlet sets or updates the setting for the active container identified by the parameter `Identity`. The cmdlet throws an error if the identity of an archived container is provided. You must be a SharePoint Embedded Administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the online documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the online documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -71,12 +68,12 @@ For permissions and the most current information about Windows PowerShell for Sh Set-SPOContainer -Identity https://contoso.sharepoint.com/contentstorage/CSP_33a63968-abae-49a3-a255-f83d0ab2260a/ -BlockDownloadPolicy $true ``` -Example 1 sets the Block Download policy on the Container mentioned in the Identity parameter. +Example 1 sets the Block Download policy on the Container mentioned in the Identity parameter. ### Example 2 ```powershell -Set-SPOContainer -Identity https://contoso.sharepoint.com/contentstorage/CSP_33a63968-abae-49a3-a255-f83d0ab2260a/ -ConditionalAccessPolicy AllowLimitedAccess +Set-SPOContainer -Identity https://contoso.sharepoint.com/contentstorage/CSP_33a63968-abae-49a3-a255-f83d0ab2260a/ -ConditionalAccessPolicy AllowLimitedAccess ``` In this example, limited access is provided to content residing in the container. @@ -96,28 +93,12 @@ This example removes any previously set sensitivity label on the container. ## PARAMETERS -### -Identity - -Use this parameter to specify the container url. - -```yaml -Type: String -Applicable: SharePoint Embedded -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowEditing Prevents users from editing Office files in the browser and copying and pasting Office file contents out of the browser window. -PARAMVALUE: False | True - ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ConditionalAccess Aliases: @@ -133,7 +114,7 @@ Accept wildcard characters: False The conditional access authentication context name. ```yaml -Type: String +Type: System.String Parameter Sets: ConditionalAccess Aliases: @@ -150,16 +131,14 @@ As a SharePoint Embedded Administrator, you can block the download of files from 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). -PARAMVALUE: $true | $false - ```yaml -Type: Boolean -Parameter Sets: ParamSet1 +Type: System.Boolean +Parameter Sets: BlockDownloadPolicy Aliases: Applicable: SharePoint Embedded Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -173,24 +152,10 @@ Possible values: - BlockAccess: Blocks access. ```yaml -Type: SPOConditionalAccessPolicyType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Embedded -Required: False -Position: Named -Default value: AllowFullAccess -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SensitivityLabel -Specifies the unique identifier (GUID) of the SensitivityLabel. - -```yaml -Type: String -Parameter Sets: ParamSet1 +Type: Microsoft.Online.SharePoint.TenantManagement.SPOConditionalAccessPolicyType +Parameter Sets: ConditionalAccess Aliases: +Accepted values: AllowFullAccess, AllowLimitedAccess, BlockAccess, AuthenticationContext Applicable: SharePoint Embedded Required: False Position: Named @@ -199,13 +164,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoveLabel -This parameter allows you to remove the assigned sensitivity label on a container. +### -ExcludeBlockDownloadPolicyContainerOwners +Controls if container owners are excluded from block download policy. ```yaml -Type: SwitchParameter -Parameter Sets: ParamSet5 +Type: System.Boolean +Parameter Sets: BlockDownloadPolicy Aliases: + Required: False Position: Named Default value: None @@ -213,20 +179,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeBlockDownloadPolicyContainerOwners -Controls if container owners are excluded from block download policy. +### -Identity -PARAMVALUE: False | True +Use this parameter to specify the container url. ```yaml -Type: Boolean -Parameter Sets: BlockDownloadPolicy +Type: Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind +Parameter Sets: (All) Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -240,7 +205,7 @@ LimitedAccessFileType WebPreviewableFiles (default): Allows users to preview Off LimitedAccessFileType OtherFiles: Allows users to download files that can't be previewed, such as .zip and .exe. This option offers less security. ```yaml -Type: SPOLimitedAccessFileType +Type: Microsoft.Online.SharePoint.TenantManagement.SPOLimitedAccessFileType Parameter Sets: ConditionalAccess Aliases: Accepted values: OfficeOnlineFilesOnly, WebPreviewableFiles, OtherFiles @@ -255,10 +220,8 @@ Accept wildcard characters: False ### -ReadOnlyForBlockDownloadPolicy Controls if read-only should be enabled for block download policy. -PARAMVALUE: False | True - ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: BlockDownloadPolicy Aliases: @@ -272,10 +235,8 @@ Accept wildcard characters: False ### -ReadOnlyForUnmanagedDevices Controls whether unmanaged devices have read-only access. -PARAMVALUE: False | True - ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ConditionalAccess Aliases: @@ -286,11 +247,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoveLabel +This parameter allows you to remove the assigned sensitivity label on a container. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ParamSet2 +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SensitivityLabel +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SharingAllowedDomainList 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". ```yaml -Type: String +Type: System.String Parameter Sets: AllowDenyDomain Aliases: @@ -305,7 +295,7 @@ Accept wildcard characters: False 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". ```yaml -Type: String +Type: System.String Parameter Sets: AllowDenyDomain Aliases: @@ -321,12 +311,12 @@ Specifies the sharing mode for external domains. Possible values are: -None - Do not restrict sharing by domain -AllowList - Sharing is allowed only with external users that have account on domains specified with -SharingAllowedDomainList -BlockList - Sharing is allowed with external users in all domains except in domains specified with -SharingBlockedDomainList +- None - Do not restrict sharing by domain +- AllowList - Sharing is allowed only with external users that have account on domains specified with -SharingAllowedDomainList +- BlockList - Sharing is allowed with external users in all domains except in domains specified with -SharingBlockedDomainList ```yaml -Type: SharingDomainRestrictionModes +Type: Microsoft.Online.SharePoint.TenantManagement.SharingDomainRestrictionModes Parameter Sets: AllowDenyDomain Aliases: Accepted values: None, AllowList, BlockList @@ -338,16 +328,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind +## OUTPUTS +### System.Object +## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Set-SPOTenant](./set-spotenant.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerType.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerType.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerType.md index 5b389a9fa..75e52cb92 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerType.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spocontainertype applicable: SharePoint Online @@ -9,7 +9,7 @@ author: ShreyasSar26 ms.author: shsaravanan ms.reviewer: --- - + # Set-SPOContainerType ## SYNOPSIS @@ -24,6 +24,12 @@ Set-SPOContainerType -ContainerTypeId [-ContainerTypeName] [-Wha [] ``` +### OwningApplicationId +``` +Set-SPOContainerType -ContainerTypeId [-OwningApplicationId] [-WhatIf] [-Confirm] + [] +``` + ### AzureSubscriptionId ``` Set-SPOContainerType -ContainerTypeId [[-AzureSubscriptionId] ] [-ResourceGroup] @@ -50,28 +56,28 @@ For permissions and the most current information about Windows PowerShell for Sh ## EXAMPLES ### Example 1 - + ```powershell -Set-SPOContainerType -ContainerTypeId da1d89b3-b4cf-4c0a-8e1c-0d131c57544f -OwningApplicationId 12a9d93c-18d7-46a0-b43e-28d20addd56a - ContainerTypeName 'Red Container Type' +Set-SPOContainerType -ContainerTypeId da1d89b3-b4cf-4c0a-8e1c-0d131c57544f -OwningApplicationId 12a9d93c-18d7-46a0-b43e-28d20addd56a - ContainerTypeName 'Red Container Type' ``` - + Example 1 sets the container type name as 'Red Container Type' - + ### Example 2 - + ```powershell Set-SPOContainerType -ContainerTypeId da1d89b3-b4cf-4c0a-8e1c-0d131c57544f –Azure Subscription 12a9d93c-18d7-46a0-b43e-28d20addd56a -ResourceGroup RG200 ``` - + In Example 2, the billing profile of the container type is updated. ### Example 3 - + ```powershell -Set-SPOContainerType -ContainerTypeId 01f62754-0873-4ec6-ab4a-3eed48ba8be7 -OwningApplicationId 994b9586-253e-4a77-b51 - ContainerTypeName 'Blue Container Type' +Set-SPOContainerType -ContainerTypeId 01f62754-0873-4ec6-ab4a-3eed48ba8be7 -OwningApplicationId 994b9586-253e-4a77-b51 - ContainerTypeName 'Blue Container Type' ``` -In Example 3, the trial container type name is updated as 'Blue Container Type' +In Example 3, the trial container type name is updated as 'Blue Container Type' ## PARAMETERS @@ -80,7 +86,7 @@ In Example 3, the trial container type name is updated as 'Blue Container Type' This parameter sets the application redirect Url for the container type. ```yaml -Type: String +Type: System.String Parameter Sets: ApplicationRedirectUrl Aliases: @@ -95,7 +101,7 @@ Accept wildcard characters: False Use this parameter to set the Azure billing subscription ID you wish to attach to the container type. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: AzureSubscriptionId Aliases: @@ -106,42 +112,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ContainerTypeId +Use this parameter to enter the container type ID ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ContainerTypeId -Use this parameter to enter the container type ID +### -ContainerTypeName +Use this parameter to pass the conatiner type name you intend to use for the container type ```yaml -Type: Guid -Parameter Sets: (All) +Type: System.String +Parameter Sets: ContainerTypeName Aliases: Required: True -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ContainerTypeName -Use this parameter to pass the conatiner type name you intend to use for the container type +### -OwningApplicationId +{{ Fill OwningApplicationId Description }} ```yaml -Type: String -Parameter Sets: ContainerTypeName +Type: System.Guid +Parameter Sets: OwningApplicationId Aliases: Required: True @@ -152,10 +158,10 @@ Accept wildcard characters: False ``` ### -ResourceGroup -Use this parameter to set the Azure resource group of the associated Azure billing subscription you intend to attach to the container type. +Use this parameter to set the Azure resource group of the associated Azure billing subscription you intend to attach to the container type. ```yaml -Type: String +Type: System.String Parameter Sets: AzureSubscriptionId Aliases: @@ -166,12 +172,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -183,7 +204,17 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerTypeConfiguration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerTypeConfiguration.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md index 24ce3bc0b..f3d12260f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerTypeConfiguration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerTypeConfiguration.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-SPOContainerTypeConfiguration applicable: SharePoint Online @@ -17,21 +17,21 @@ ms.reviewer: Sets or updates the configuration settings of a container type in SharePoint Embedded. ## SYNTAX -```powershell + +``` Set-SPOContainerTypeConfiguration -ContainerTypeId [-DiscoverabilityDisabled ] [-SharingRestricted ] [-ApplicationRedirectUrl ] [-WhoCanShareAnonymousAllowList ] [-WhoCanShareAuthenticatedGuestAllowList ] [-OverrideTenantWhoCanShareAnonymousAllowList ] [-OverrideTenantWhoCanShareAuthenticatedGuestAllowList ] - [[-CopilotEmbeddedChatHosts] ] - [-AnonymousLinkExpirationInDays ] [-WhatIf] [-Confirm] - [] + [-CopilotEmbeddedChatHosts ] + [-AnonymousLinkExpirationInDays ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION For any parameters passed in, the `Set-SPOContainerTypeConfiguration` cmdlet sets or updates the settings for a container type created under a SharePoint Embedded application. -You must be a SharePoint Embedded Administrator to run this cmdlet. +You must be a SharePoint Embedded Administrator to run this cmdlet. ## EXAMPLES @@ -54,7 +54,7 @@ Example 2 turns on an open sharing model for this container type. Any container ### Example 3 ```powershell -Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -OverrideTenantWhoCanShareAnonymousAllowList $true -WhoCanShareAnonymousAllowList +Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -OverrideTenantWhoCanShareAnonymousAllowList $true -WhoCanShareAnonymousAllowList ``` Example 3 overrides the tenant-level `WhoCanShareAnonymousAllowList`. @@ -70,7 +70,7 @@ Example 4 overrides the tenant-level `WhoCanShareAnonymousAllowList` and `WhoCan ### Example 5 ```powershell -Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -OverrideTenantWhoCanShareAuthenticatedGuestAllowList $true –WhoCanShareAuthenticatedGuestAllowList $null +Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -OverrideTenantWhoCanShareAuthenticatedGuestAllowList $true –WhoCanShareAuthenticatedGuestAllowList $null ``` Example 5 overrides the tenant-level `WhoCanShareAuthenticatedGuestAllowList` with a null value, while leaving the `WhoCanShareAnonymousAllowList` untouched. This has the effect of no longer restricting the privilege of sharing to authenticated guests to members of specific security groups. @@ -78,7 +78,7 @@ Example 5 overrides the tenant-level `WhoCanShareAuthenticatedGuestAllowList` wi ### Example 6 ```powershell -Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585 -CopilotEmbeddedChatHosts "http://localhost:3000 https://contoso.sharepoint.com https://fabrikam.com" +Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585 -CopilotEmbeddedChatHosts "https://localhost:3000 https://contoso.sharepoint.com https://fabrikam.com" ``` This example sets the host URLs for the container type with Id 4f0af585. @@ -86,13 +86,13 @@ This example sets the host URLs for the container type with Id 4f0af585. ### -AnonymousLinkExpirationInDays Specifies all anonymous links created after the value is set will expire after the set number of days. - + The value can be from 1 to 730 days. - + To defer to the tenant level setting, set the value to -1. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -105,10 +105,10 @@ Accept wildcard characters: False ### -ApplicationRedirectUrl -This parameter specifies the url of that the application should be redirected to. +This parameter specifies the url of that the application should be redirected to. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -124,7 +124,7 @@ Accept wildcard characters: False This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -136,7 +136,7 @@ Accept wildcard characters: False ``` ### -CopilotEmbeddedChatHosts -This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience. +This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience. ```yaml Type: System.Collections.Generic.List`1[System.String] @@ -144,7 +144,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -158,11 +158,13 @@ If you opt into the Microsoft 365 experience, your files will be integrated into PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean +Parameter Sets: (All) +Aliases: Applicable: SharePoint Embedded -Position: Named Required: False -Default value: True +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -180,7 +182,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -192,13 +194,13 @@ This setting determines if the container type `WhoCanShareAuthenticatedGuestAllo PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -206,15 +208,17 @@ Accept wildcard characters: False ### -SharingRestricted 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 ```yaml -Type: Boolean +Type: System.Boolean +Parameter Sets: (All) +Aliases: Applicable: SharePoint Embedded -Position: Named Required: False -Default value: True +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -226,10 +230,10 @@ Sets a container type-specific list of security groups who are allowed to share > [!NOTE] > This allow list only accepts security groups, and not Microsoft 365 Groups. -Each security group is denoted by its GUID object ID. To set this list to be a specific security group, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them. To skip the check and allow all security groups to share to anyone, set this allow list and the `WhoCanShareAuthenticatedGuestAllowList` to null arrays. +Each security group is denoted by its GUID object ID. To set this list to be a specific security group, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them. To skip the check and allow all security groups to share to anyone, set this allow list and the `WhoCanShareAuthenticatedGuestAllowList` to null arrays. ```yaml -Type: Guid[] +Type: System.Guid[] Parameter Sets: (All) Aliases: @@ -251,7 +255,7 @@ Each security group is denoted by its GUID object ID. To set this list to be a s ```yaml -Type: Guid[] +Type: System.Guid[] Parameter Sets: (All) Aliases: @@ -262,8 +266,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerUser.md new file mode 100644 index 000000000..03e29cb0b --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContainerUser.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOContainerUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOContainerUser [-ContainerId] -LoginName -Role [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContainerId +{{ Fill ContainerId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoginName +{{ Fill LoginName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +{{ Fill Role Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Accepted values: Owner, Reader, Writer, Manager + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContentEventEmailAddresses.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContentEventEmailAddresses.md similarity index 69% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContentEventEmailAddresses.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContentEventEmailAddresses.md index b9a582eb3..5648c64c5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContentEventEmailAddresses.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOContentEventEmailAddresses.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spocontenteventemailaddresses applicable: SharePoint Online @@ -19,8 +19,9 @@ Adds the email addresses to the specified category of content event. Consequentl ## SYNTAX -```powershell -Set-SPOContentEventEmailAddresses [-Category] [-EmailAddresses] +``` +Set-SPOContentEventEmailAddresses [-Category] [-EmailAddresses] + [] ``` ## DESCRIPTION @@ -44,12 +45,13 @@ In Example 1, the email addresses joe.doe@contoso.com and john.dow@contoso.com h Specifies the content event category. ```yaml -Type: ContentEventCategory +Type: Microsoft.SharePoint.Administration.TenantAdmin.ContentEventCategory Parameter Sets: (All) Aliases: +Accepted values: Unknown, Ransomware, HighVolumeDownload, HighVolumeDelete, HighVolumeShare Applicable: SharePoint Online Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -60,21 +62,32 @@ Accept wildcard characters: False List of comma seperated email addresses ```yaml -Type: strings +Type: System.String[] Parameter Sets: (All) +Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES ## RELATED LINKS [Get-SPOContentEventEmailAddresses](Get-SPOContentEventEmailAddresses.md) -[Remove-SPOContentEventEmailAddresses](Remove-SPOContentEventEmailAddresses.md) \ No newline at end of file +[Remove-SPOContentEventEmailAddresses](Remove-SPOContentEventEmailAddresses.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCopilotPromoOptInStatus.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md similarity index 66% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCopilotPromoOptInStatus.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md index b0056f8ef..fb9b6fa0b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCopilotPromoOptInStatus.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCopilotPromoOptInStatus.md @@ -1,10 +1,10 @@ --- -external help file: sharepointonline.xml +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-SPOCopilotPromoOptInStatus applicable: SharePoint Online title: Set-SPOCopilotPromoOptInStatus -schema: +schema: author: siruvanti ms.author: siruvanti ms.reviewer: @@ -18,12 +18,12 @@ Sets the Opt-In Copilot promo status for the tenant. ## SYNTAX ``` -Set-SPOCopilotPromoOptInStatus -IsCopilotPromoStatusEnabled +Set-SPOCopilotPromoOptInStatus -IsCopilotPromoStatusEnabled [] ``` ## DESCRIPTION -This cmdlet sets the Opt-In Copilot promo status for the tenant to `True` or `False`. +This cmdlet sets the Opt-In Copilot promo status for the tenant to `True` or `False`. ## EXAMPLES @@ -38,10 +38,10 @@ Example 1 sets the Opt-In Copilot promo status for the tenant to `True`. ## PARAMETERS ### -IsCopilotPromoStatusEnabled -Use this parameter to set Copilot opt-in promo status. +Use this parameter to set Copilot opt-in promo status. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -53,6 +53,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS - [Get-SPOCopilotPromoOptInStatus](./Get-SPOCopilotPromoOptInStatus.md) - [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantQuota.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantQuota.md new file mode 100644 index 000000000..c40430f1d --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantQuota.md @@ -0,0 +1,46 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOCrossTenantQuota + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOCrossTenantQuota [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCrossTenantRelationship.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md similarity index 75% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCrossTenantRelationship.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md index eaae82cd0..9f6919fba 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCrossTenantRelationship.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCrossTenantRelationship.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spocrosstenantrelationship applicable: SharePoint Online @@ -18,8 +18,9 @@ This cmdlet sends a trust request to the tenant with whom you want to establish ## SYNTAX -```powershell -Set-SPOCrossTenantRelationship -PartnerCrossTenantHostUrl -PartnerRole -Scenario [] +``` +Set-SPOCrossTenantRelationship [-Scenario] [-PartnerRole] + [-PartnerCrossTenantHostUrl] [] ``` ## DESCRIPTION @@ -42,13 +43,13 @@ This cmdlet sends a trust request to the Contoso tenant. 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -58,14 +59,14 @@ Accept wildcard characters: False 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 -Type: OrgRelationRole +Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole Parameter Sets: (All) Aliases: -Accepted values: Target, Source +Accepted values: None, Source, Target Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -74,14 +75,14 @@ Accept wildcard characters: False ### -Scenario ```yaml -Type: OrgRelationScenario +Type: Microsoft.SharePoint.Client.Administration.OrgRelationScenario Parameter Sets: (All) Aliases: -Accepted values: MnA, None +Accepted values: None, MnA Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -91,6 +92,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCustomFontCatalog.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCustomFontCatalog.md new file mode 100644 index 000000000..dc1789262 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOCustomFontCatalog.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOCustomFontCatalog + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOCustomFontCatalog -LibraryUrl -FontFolder [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -FontFolder +{{ Fill FontFolder Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LibraryUrl +{{ Fill LibraryUrl Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODisableSpacesActivation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPODisableSpacesActivation.md similarity index 88% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPODisableSpacesActivation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPODisableSpacesActivation.md index bebdf115a..c36905c1d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODisableSpacesActivation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPODisableSpacesActivation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spodisablespacesactivation applicable: SharePoint Online @@ -44,26 +44,11 @@ This example disables the SharePoint Spaces activation for a site. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Disable Set True to disable SharePoint Spaces activation, set to False to enable. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -78,7 +63,7 @@ Accept wildcard characters: False Specifies the URL of the site collection to update. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: @@ -97,7 +82,7 @@ Possible values: - Site ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -108,12 +93,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -125,7 +125,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -134,6 +134,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md similarity index 87% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md index 5c4ad5fab..226ecc9b8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOGeoStorageQuota.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spogeostoragequota applicable: SharePoint Online @@ -18,7 +18,7 @@ This cmdlet sets the storage quota on a multi-geo tenant. ## SYNTAX -```powershell +``` Set-SPOGeoStorageQuota -GeoLocation -StorageQuotaMB [] ``` @@ -51,7 +51,7 @@ Sets the SharePoint Online Storage Quota on the **NORTH CENTRAL US** location to The desired Geo Location to set. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -68,7 +68,7 @@ Accept wildcard characters: False SharePoint Online Storage Quota in MegaBytes. ```yaml -Type: Int64 +Type: System.Int64 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -84,9 +84,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHideDefaultThemes.md similarity index 89% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHideDefaultThemes.md index 72f39b467..b4abb98de 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHideDefaultThemes.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spohidedefaultthemes applicable: SharePoint Online @@ -18,7 +18,7 @@ Specifies whether the default themes should be available. ## SYNTAX -```powershell +``` Set-SPOHideDefaultThemes [-HideDefaultThemes] [] ``` @@ -62,7 +62,7 @@ Set-SPOHideDefaultThemes $false Determines whether to hide the default themes. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -75,7 +75,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -89,6 +89,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOHideDefaultThemes](Get-SPOHideDefaultThemes.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHomeSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHomeSite.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHomeSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHomeSite.md index f09ff940f..377b895d5 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHomeSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHomeSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spohomesite applicable: SharePoint Online @@ -18,13 +18,14 @@ Sets a SharePoint Site as a Home Site. ## SYNTAX -```powershell -Set-SPOHomeSite -HomeSiteUrl [-VivaConnectionsDefaultStart ] [] +``` +Set-SPOHomeSite -HomeSiteUrl [-VivaConnectionsDefaultStart ] [-Force] [-DraftMode ] + [] ``` ## DESCRIPTION -Use this cmdlet to set a SharePoint Site as a Home Site. A home site is a communication site that you create and set as the top landing page for all users in your intranet. For more information, see [Set up a home site for your organization](https://learn.microsoft.com/SharePoint/home-site) +Use this cmdlet to set a SharePoint Site as a Home Site. A home site is a communication site that you create and set as the top landing page for all users in your intranet. For more information, see [Set up a home site for your organization](/SharePoint/home-site) ## EXAMPLES @@ -43,14 +44,45 @@ Sets the home site to the provided site collection url and keeps the Viva Connec ## PARAMETERS +### -DraftMode +{{ Fill DraftMode Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HomeSiteUrl Sets the URL of the site collection to be the home site. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: + Required: True Position: Named Default value: None @@ -59,10 +91,10 @@ Accept wildcard characters: False ``` ### -VivaConnectionsDefaultStart -When set to $true, the VivaConnectionsDefaultStart parameter will keep the Viva Connections landing experience to the SharePoint home site for the desktop experience. If set to $false, the Viva Connections home experience will be used. This command doesn't impact the mobile experience. +When set to $true, the VivaConnectionsDefaultStart parameter will keep the Viva Connections landing experience to the SharePoint home site for the desktop experience. If set to $false, the Viva Connections home experience will be used. This command doesn't impact the mobile experience. ```yaml -Type: SwitchParameter +Type: System.Boolean Parameter Sets: (All) Aliases: Required: False diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md similarity index 70% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md index 6c49cd6af..ce694919a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOHubSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spohubsite applicable: SharePoint Online @@ -18,8 +18,10 @@ Sets the hub site information such as name, logo, and description. ## SYNTAX -```powershell -Set-SPOHubSite [-Identity] [-Title ] [-LogoUrl ] [-Description ] [-SiteDesignId ] [-RequiresJoinApproval ] [] +``` +Set-SPOHubSite [-Identity] [-Title ] [-LogoUrl ] [-Description ] + [-SiteDesignId ] [-RequiresJoinApproval ] [-HideNameInNavigation ] + [-EnablePermissionsSync ] [] ``` ## DESCRIPTION @@ -43,32 +45,45 @@ This example updates the name of the hub displayed in the SharePoint user interf ## PARAMETERS -### -Identity +### -Description -URL of the hub site. +A description of the hub site. ```yaml -Type: SpoSitePipeBind +Type: System.String Parameter Sets: (All) -Aliases: HubSite +Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Title +### -EnablePermissionsSync +{{ Fill EnablePermissionsSync Description }} -The display name of the hub. +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HideNameInNavigation +{{ Fill HideNameInNavigation Description }} ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online Required: False Position: Named @@ -77,12 +92,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +URL of the hub site. + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind +Parameter Sets: (All) +Aliases: HubSite +Applicable: SharePoint Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -LogoUrl The URL of a logo to use in the hub navigation. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -94,12 +126,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -RequiresJoinApproval -A description of the hub site. +Determines if joining a Hub site requires approval. ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -116,7 +148,7 @@ Accept wildcard characters: False Site Design ID, for example db752673-18fd-44db-865a-aa3e0b28698e ```yaml -Type: String +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -128,12 +160,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequiresJoinApproval +### -Title -Determines if joining a Hub site requires approval. +The display name of the hub. ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -146,5 +178,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOKnowledgeHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOKnowledgeHubSite.md new file mode 100644 index 000000000..d4ff7b72c --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOKnowledgeHubSite.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOKnowledgeHubSite + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOKnowledgeHubSite -KnowledgeHubSiteUrl [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -KnowledgeHubSiteUrl +{{ Fill KnowledgeHubSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOListVersionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOListVersionPolicy.md similarity index 89% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOListVersionPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOListVersionPolicy.md index 66da97632..fbf27911f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOListVersionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOListVersionPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spolistversionpolicy applicable: SharePoint Online @@ -19,8 +19,10 @@ Sets the version policy setting on the document library. ## SYNTAX -```powershell -Set-SPOListVersionPolicy [-Site] [-List] [-EnableAutoExpirationVersionTrim ] [-MajorVersionLimit ] [-MajorWithMinorVersionsLimit ] [-ExpireVersionsAfterDays ] [] +``` +Set-SPOListVersionPolicy [-Site] -List + -EnableAutoExpirationVersionTrim [-ExpireVersionsAfterDays ] [-MajorVersionLimit ] + [-MajorWithMinorVersionsLimit ] [] ``` ## DESCRIPTION @@ -53,65 +55,67 @@ Example 3 sets manual version histroy limits on the document library called "Doc ## PARAMETERS -### -Site +### -EnableAutoExpirationVersionTrim +Global and SharePoint Administrators can set document library level version history limits settings that universally apply to new versions created. -Specifies the URL of the site. +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. + +The valid values are: + +- True - Version history limits for new versions created on the document library will be managed automatically. +- False - Version history limits for new Versions created on the document library will be managed manually by setting limits to the number of major versions (`MajorVersionLimit`), number of major with minor versions (`MajorWithMinorVersionsLimit`) and time set (`ExpireVersionsAfterDays`). Review the documentation of both parameters to manage your organization's version limits manually. + +> [!NOTE] +> When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), `MajorVersionLimit`, `MajorWithMinorVersionsLimit` and `ExpireVersionsAfterDays` are required parameters with the following acceptable values: +> a. `MajorVersionLimit` accepts values from 1 through 50,000 (inclusive). +> b. `MajorWithMinorVersionsLimit` accepts values from 0 through 50,000 (inclusive). +> c. `ExpireVersionsAfterDays` accepts values of 0 to Never Expire or values >= 30 to delete versions that exceed that time period. +> When Version history limits are managed automatically (`EnableAutoExpirationVersionTrim $true`), setting `MajorVersionLimit` or `ExpireVersionsAfterDays` will result in an error as the count limits are set by the service. + +PARAMVALUE: $true | $false ```yaml -Type: SpoSitePipeBind +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -List +### -ExpireVersionsAfterDays +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. -The document library name or Id. +PARAMVALUE: Int32 ```yaml -Type: SPOListPipeBind +Type: System.Int32 Parameter Sets: (All) - -Required: True +Aliases: +Applicable: SharePoint Online +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAutoExpirationVersionTrim -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. - -The valid values are: - -- True - Version history limits for new versions created on the document library will be managed automatically. -- False - Version history limits for new Versions created on the document library will be managed manually by setting limits to the number of major versions (`MajorVersionLimit`), number of major with minor versions (`MajorWithMinorVersionsLimit`) and time set (`ExpireVersionsAfterDays`). Review the documentation of both parameters to manage your organization's version limits manually. - -> [!NOTE] -> When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), `MajorVersionLimit`, `MajorWithMinorVersionsLimit` and `ExpireVersionsAfterDays` are required parameters with the following acceptable values: -> a. `MajorVersionLimit` accepts values from 1 through 50,000 (inclusive). -> b. `MajorWithMinorVersionsLimit` accepts values from 0 through 50,000 (inclusive). -> c. `ExpireVersionsAfterDays` accepts values of 0 to Never Expire or values >= 30 to delete versions that exceed that time period. -> When Version history limits are managed automatically (`EnableAutoExpirationVersionTrim $true`), setting `MajorVersionLimit` or `ExpireVersionsAfterDays` will result in an error as the count limits are set by the service. +### -List -PARAMVALUE: $true | $false +The document library name or Id. ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online -Required: False + +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -121,7 +125,7 @@ When version history limits are managed manually (`EnableAutoExpirationVersionTr PARAMVALUE: Int32 ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -138,7 +142,7 @@ When version history limits are managed manually (`EnableAutoExpirationVersionTr PARAMVALUE: Int32 ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -149,20 +153,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExpireVersionsAfterDays -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. +### -Site -PARAMVALUE: Int32 +Specifies the URL of the site. ```yaml -Type: Int32 +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -170,6 +173,18 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +### Microsoft.Online.SharePoint.PowerShell.SPOListPipeBind + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Get-SPOListVersionPolicy](Get-SPOListVersionPolicy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md similarity index 76% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md index a2d682131..af7ee384e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMigrationPackageAzureSource.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spomigrationpackageazuresource applicable: SharePoint Online @@ -19,40 +19,39 @@ Cmdlet to create Azure containers, upload migration package files into the appro ## SYNTAX ### ImplicitSourceExplicitAzure - -```powershell -Set-SPOMigrationPackageAzureSource -AccountKey -AccountName [-AzureQueueName ] - [-EncryptionMetaInfo ] [-EncryptionParameters ] - [-FileContainerName ] -MigrationSourceLocations [-NoLogFile] - [-NoSnapshotCreation] [-NoUpload] [-Overwrite] [-PackageContainerName ] [] ``` - -### ExplicitSourceExplicitAzure - -```powershell -Set-SPOMigrationPackageAzureSource -AccountKey -AccountName [-AzureQueueName ] - [-EncryptionMetaInfo ] [-EncryptionParameters ] - [-FileContainerName ] [-NoLogFile] [-NoSnapshotCreation] [-NoUpload] [-Overwrite] - [-PackageContainerName ] -SourceFilesPath -SourcePackagePath [] +Set-SPOMigrationPackageAzureSource -MigrationSourceLocations + [-FileContainerName ] [-PackageContainerName ] [-AzureQueueName ] + -AccountName -AccountKey [-EncryptionParameters ] [-NoUpload] + [-NoSnapshotCreation] [-EncryptionMetaInfo ] [-NoLogFile] [-Overwrite] + [-ParallelUpload] [] ``` ### ImplicitSourceImplicitAzure - -```powershell -Set-SPOMigrationPackageAzureSource [-EncryptionMetaInfo ] - [-EncryptionParameters ] +``` +Set-SPOMigrationPackageAzureSource -MigrationSourceLocations -MigrationPackageAzureLocations - -MigrationSourceLocations [-NoLogFile] [-NoSnapshotCreation] [-NoUpload] - [-Overwrite] [] + [-EncryptionParameters ] [-NoUpload] [-NoSnapshotCreation] + [-EncryptionMetaInfo ] [-NoLogFile] [-Overwrite] [-ParallelUpload] + [] ``` -### ExplicitSourceImplicitAzure +### ExplicitSourceExplicitAzure +``` +Set-SPOMigrationPackageAzureSource -SourceFilesPath -SourcePackagePath + [-FileContainerName ] [-PackageContainerName ] [-AzureQueueName ] + -AccountName -AccountKey [-EncryptionParameters ] [-NoUpload] + [-NoSnapshotCreation] [-EncryptionMetaInfo ] [-NoLogFile] [-Overwrite] + [-ParallelUpload] [] +``` -```powershell -Set-SPOMigrationPackageAzureSource [-EncryptionMetaInfo ] - [-EncryptionParameters ] - -MigrationPackageAzureLocations [-NoLogFile] [-NoSnapshotCreation] - [-NoUpload] [-Overwrite] -SourceFilesPath -SourcePackagePath [] +### ExplicitSourceImplicitAzure +``` +Set-SPOMigrationPackageAzureSource -SourceFilesPath -SourcePackagePath + -MigrationPackageAzureLocations + [-EncryptionParameters ] [-NoUpload] [-NoSnapshotCreation] + [-EncryptionMetaInfo ] [-NoLogFile] [-Overwrite] [-ParallelUpload] + [] ``` ## DESCRIPTION @@ -86,7 +85,7 @@ This example uses existing migration package containers in Azure storage to snap The account key for the Azure Storage account. ```yaml -Type: String +Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: Applicable: SharePoint Online @@ -102,7 +101,7 @@ Accept wildcard characters: False The account name for the Azure Storage account. ```yaml -Type: String +Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: Applicable: SharePoint Online @@ -118,7 +117,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: Applicable: SharePoint Online @@ -134,7 +133,7 @@ Accept wildcard characters: False PARAMVALUE: MigrationFileEncryptionInfo[] ```yaml -Type: MigrationFileEncryptionInfo[] +Type: Microsoft.Online.SharePoint.Migration.MigrationFileEncryptionInfo[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -147,10 +146,10 @@ Accept wildcard characters: False ### -EncryptionParameters -An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](https://learn.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. +An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. ```yaml -Type: EncryptionParameters +Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -167,7 +166,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: Applicable: SharePoint Online @@ -183,7 +182,7 @@ Accept wildcard characters: False 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: MigrationPackageAzureLocations +Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: ImplicitSourceImplicitAzure, ExplicitSourceImplicitAzure Aliases: Applicable: SharePoint Online @@ -199,7 +198,7 @@ Accept wildcard characters: False Possible Source locations to migrate. ```yaml -Type: MigrationPackageLocation +Type: Microsoft.Online.SharePoint.Migration.MigrationPackageLocation Parameter Sets: ImplicitSourceExplicitAzure, ImplicitSourceImplicitAzure Aliases: Applicable: SharePoint Online @@ -215,7 +214,7 @@ Accept wildcard characters: False 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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -231,7 +230,7 @@ Accept wildcard characters: False 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: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -247,7 +246,7 @@ Accept wildcard characters: False Indicates to not upload the package files. The default is to upload all the package files. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -261,7 +260,7 @@ Accept wildcard characters: False ### -Overwrite ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -277,7 +276,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure Aliases: Applicable: SharePoint Online @@ -288,12 +287,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParallelUpload +{{ Fill ParallelUpload Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SourceFilesPath The directory location where the package's source content files exist. ```yaml -Type: String +Type: System.String Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure Aliases: Applicable: SharePoint Online @@ -309,7 +323,7 @@ Accept wildcard characters: False The directory location where the package's metadata files exist. ```yaml -Type: String +Type: System.String Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoCompanyAllowedDataLocation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoCompanyAllowedDataLocation.md similarity index 75% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoCompanyAllowedDataLocation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoCompanyAllowedDataLocation.md index 7eba70d13..8eed3735a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoCompanyAllowedDataLocation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoCompanyAllowedDataLocation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spomultigeocompanyalloweddatalocation applicable: SharePoint Online @@ -18,8 +18,9 @@ Adds a multi-geo allowed location. ## SYNTAX -```powershell -Set-SPOMultiGeoCompanyAllowedDataLocation [-Location] [-InitialDomain] [-WhatIf] [-Confirm] [] +``` +Set-SPOMultiGeoCompanyAllowedDataLocation [-Location] [-InitialDomain] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -38,33 +39,33 @@ Sets AUS (Australia) as an allowed multi-geo location for the domain contoso.com ## PARAMETERS -### -Location +### -InitialDomain -The Preferred Data Location (PDL) to allow. +Sets the initial domain to associate with the specified data location. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InitialDomain +### -Location -Sets the initial domain to associate with the specified data location. +The Preferred Data Location (PDL) to allow. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -76,7 +77,7 @@ Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -88,12 +89,11 @@ Accept wildcard characters: False ``` ### -WhatIf - -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` +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -105,11 +105,18 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +### System.Object ## NOTES ## RELATED LINKS -[Remove-SPOMultiGeoCompanyAllowedDataLocation](https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spomultigeocompanyalloweddatalocation) +[Remove-SPOMultiGeoCompanyAllowedDataLocation](/powershell/module/sharepoint-online/remove-spomultigeocompanyalloweddatalocation) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoExperience.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoExperience.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoExperience.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoExperience.md index 468e83a54..f12b0019b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoExperience.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOMultiGeoExperience.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spomultigeoexperience applicable: SharePoint Online @@ -18,13 +18,13 @@ Used to set a geo location into SPO mode. ## SYNTAX -```powershell - Set-SPOMultiGeoExperience [-AllInstances] [-WhatIf] [-Confirm] [] +``` +Set-SPOMultiGeoExperience [-AllInstances] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Use this cmdlet to set a geo location into SPO mode. This upgrade action is not reversible. For more information see [Enabling SharePoint Multi-Geo in your satellite geo location](https://learn.microsoft.com/office365/enterprise/enabling-sp-multigeo-satellite-geolocation) +Use this cmdlet to set a geo location into SPO mode. This upgrade action is not reversible. For more information see [Enabling SharePoint Multi-Geo in your satellite geo location](/office365/enterprise/enabling-sp-multigeo-satellite-geolocation) ## EXAMPLES @@ -43,11 +43,11 @@ This example will upgrade your instance's multi-geo experience to include ShareP . ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -60,7 +60,7 @@ Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -72,12 +72,11 @@ Accept wildcard characters: False ``` ### -WhatIf - -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` +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -92,4 +91,14 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgAssetsLibrary.md similarity index 68% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgAssetsLibrary.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgAssetsLibrary.md index 455cc1e90..5d8c5c0d6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgAssetsLibrary.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgAssetsLibrary.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spoorgassetslibrary applicable: SharePoint Online @@ -19,8 +19,9 @@ Updates information for a library that is designated as a location for organizat ## SYNTAX -```powershell -Set-SPOOrgAssetsLibrary -LibraryUrl [-ThumbnailUrl ] [-OrgAssetType ] [] +``` +Set-SPOOrgAssetsLibrary -LibraryUrl [-ThumbnailUrl ] [-OrgAssetType ] + [-CopilotSearchable ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -63,12 +64,27 @@ Set-SPOOrgAssetsLibrary -LibraryURL sites/branding/Templates -OrgAssetType Image ## PARAMETERS +### -CopilotSearchable +{{ Fill CopilotSearchable Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LibraryUrl Indicates the server relative URL of the library to be modified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -89,11 +105,11 @@ OfficeTemplateLibrary is the suggested type for Office files and will show up in In order to benefit from both UIs you can choose "ImageDocumentLibrary,OfficeTemplateLibrary" as OrgAssetType. ```yaml -Type: OrgAssetType +Type: Microsoft.Online.SharePoint.PowerShell.OrganizationAssetType Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Accepted values: ImageDocumentLibrary, OfficeTemplateLibrary +Accepted values: ImageDocumentLibrary, OfficeTemplateLibrary, OfficeFontLibrary, BrandKitLibrary Required: False Position: Named Default value: None @@ -106,31 +122,65 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### CommonParameters +### -Confirm +Prompts you for confirmation before running the cmdlet. -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Add-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/add-spoorgassetslibrary?view=sharepoint-ps) +[Add-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/add-spoorgassetslibrary) -[Get-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/get-spoorgassetslibrary?view=sharepoint-ps) +[Get-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/get-spoorgassetslibrary) -[Remove-SPOOrgAssetsLibrary](https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spoorgassetslibrary?view=sharepoint-ps) +[Remove-SPOOrgAssetsLibrary](/powershell/module/sharepoint-online/remove-spoorgassetslibrary) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md similarity index 85% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgNewsSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md index 1d67ceec1..982123758 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgNewsSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOOrgNewsSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spoorgnewssite applicable: SharePoint Online @@ -17,8 +17,8 @@ Marks a site as one of multiple possible tenant's organizational news sites. Req ## SYNTAX -```powershell -Set-SPOOrgNewsSite -OrgNewsSiteUrl [] +``` +Set-SPOOrgNewsSite -OrgNewsSiteUrl [] ``` ## DESCRIPTION @@ -44,7 +44,7 @@ This example marks as an organi The URL of a site to be marked as an organizational news site. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -57,8 +57,17 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOPortalLaunchWaves.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOPortalLaunchWaves.md new file mode 100644 index 000000000..2c09af6d1 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOPortalLaunchWaves.md @@ -0,0 +1,109 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOPortalLaunchWaves + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOPortalLaunchWaves -LaunchSiteUrl -Status [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -LaunchSiteUrl +{{ Fill LaunchSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +{{ Fill Status Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SPOPortalLaunchWavesConfiguration+StatusAction +Parameter Sets: (All) +Aliases: +Accepted values: Pause, Restart + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPORestrictedSiteCreation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPORestrictedSiteCreation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md index 1a603c7f9..44ef1b210 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPORestrictedSiteCreation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreation.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-sporestrictedsitecreation applicable: SharePoint Online @@ -18,14 +18,10 @@ Sets or updates one or more group configurations for restricting site creation. ## SYNTAX -### ParamSet1 - -```powershell -Set-SPORestrictedSiteCreation - [-Enabled ] - [-Mode ] - [-SiteType ] - [-RestrictedSiteCreationGroups ] +``` +Set-SPORestrictedSiteCreation [-Enabled ] [-Mode ] + [-SiteType ] [-RestrictedSiteCreationGroups ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -43,7 +39,7 @@ This cmdlet sets or updates the configuration or setting for the Restricted Site Set-SPORestrictedSiteCreation –Enabled:$true ``` -Example 1 enables the restricted site creation feature for the tenant. +Example 1 enables the restricted site creation feature for the tenant. ### Example 2 @@ -84,8 +80,8 @@ PARAMVALUE: true | false Enables or disables Restricted Site Creation feature in tenant. ```yaml -Type: Boolean -Parameter Sets: ParamSet1 +Type: System.Boolean +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False @@ -106,8 +102,26 @@ PARAMVALUE: Deny | Allow > The restricted site creation mode is shared across all site type policies. It is not possible to use deny mode for one site type and allow mode for a different site type. When the mode is changed, all polices are cleared. ```yaml -Type: RestrictedSiteCreationMode -Parameter Sets: ParamSet1 +Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCreationMode +Parameter Sets: (All) +Aliases: +Accepted values: Deny, Allow +Applicable: SharePoint Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictedSiteCreationGroups + +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. + +```yaml +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False @@ -122,17 +136,18 @@ Accept wildcard characters: False When paired with the `–RestrictedSiteCreationGroups` parameter, creates a new policy which applies to the specified types of sites. PARAMVALUE: All | SharePoint | OneDrive | Team | Communication -- All - OneDrive and all SharePoint sites -- SharePoint - All SharePoint sites (but not OneDrive) -- OneDrive - Only OneDrive -- Team - Only SharePoint team sites (group-connected and classic) +- All - OneDrive and all SharePoint sites +- SharePoint - All SharePoint sites (but not OneDrive) +- OneDrive - Only OneDrive +- Team - Only SharePoint team sites (group-connected and classic) - Communication - Only SharePoint communication sites ```yaml -Type: RestrictedSiteCreationSiteType -Parameter Sets: ParamSet1 +Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCreationSiteType +Parameter Sets: (All) Aliases: +Accepted values: All, SharePoint, OneDrive, Team, Communication Applicable: SharePoint Online Required: False Position: Named @@ -141,16 +156,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictedSiteCreationGroups - -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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + Required: False Position: Named Default value: None @@ -164,13 +193,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOServicePrioritizationAppRegistration.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOServicePrioritizationAppRegistration.md similarity index 84% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOServicePrioritizationAppRegistration.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOServicePrioritizationAppRegistration.md index a47b85365..b17331d9d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOServicePrioritizationAppRegistration.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOServicePrioritizationAppRegistration.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-SPOServicePrioritizationAppRegistration applicable: SharePoint Online @@ -41,7 +41,7 @@ This example updates the app registration with the specified AppId, enabling it Specifies the unique identifier (GUID) of the app registration to update. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -56,7 +56,7 @@ Accept wildcard characters: False Specifies whether the app registration is enabled or disabled. Accepts a Boolean value. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -71,7 +71,7 @@ Accept wildcard characters: False This parameter specifies the quota multiplier limit for the scaling feature. Value must be between 2 and 10. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -83,7 +83,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -92,6 +92,7 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS @@ -107,4 +108,4 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar [New-SPOServicePrioritizationBillingPolicy](./New-SPOServicePrioritizationBillingPolicy.md) -[Get-SPOServicePrioritizationBillingPolicies](./Get-SPOServicePrioritizationBillingPolicies.md) \ No newline at end of file +[Get-SPOServicePrioritizationBillingPolicies](./Get-SPOServicePrioritizationBillingPolicies.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md similarity index 79% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md index 0483f2853..218fd55c8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-sposite applicable: SharePoint Online @@ -16,122 +16,125 @@ ms.reviewer: Sets or updates one or more properties' values for a site collection. -## SYNTAX +X -### ParamSet1 +### None (Default) +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] [-WhatIf] [-Confirm] + [] +``` -```powershell -Set-SPOSite - [-AddRestrictedAccessControlGroups [Guid[]]] - [-AllowDownloadingNonWebViewableFiles ] - [-AllowEditing ] - [-AllowFileArchive ] - [-AllowSelfServiceUpgrade ] - [-AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled ] - [-AnonymousLinkExpirationInDays ] - [-AuthenticationContextAccessType ] +### ParamSet1 +``` +Set-SPOSite [-Identity] [-Owner ] [-Title ] [-StorageQuota ] + [-StorageQuotaWarningLevel ] [-ResourceQuota ] [-ResourceQuotaWarningLevel ] + [-LocaleId ] [-AllowSelfServiceUpgrade ] [-NoWait] [-LockState ] + [-DenyAddAndCustomizePages ] [-SharingCapability ] + [-ShowPeoplePickerSuggestionsForGuestUsers ] [-StorageQuotaReset] + [-SandboxedCodeActivationCapability ] + [-DisableCompanyWideSharingLinks ] + [-SharingDomainRestrictionMode ] [-SharingAllowedDomainList ] + [-SharingBlockedDomainList ] [-ConditionalAccessPolicy ] + [-AllowDownloadingNonWebViewableFiles ] [-LimitedAccessFileType ] + [-AllowEditing ] [-ReadOnlyForUnmanagedDevices ] [-SensitivityLabel ] + [-DisableAppViews ] [-DisableFlows ] + [-MediaTranscription ] [-BlockDownloadPolicy ] + [-ExcludedBlockDownloadGroupIds ] [-ExcludeBlockDownloadPolicySiteOwners ] + [-ReadOnlyForBlockDownloadPolicy ] [-ExcludeBlockDownloadSharePointGroups ] [-AuthenticationContextName ] + [-AuthenticationContextAccessType ] + [-RestrictedToGeo ] [-CommentsOnSitePagesDisabled ] [-UpdateUserTypeFromAzureAD] + [-SocialBarOnSitePagesDisabled ] [-HubSiteId ] [-DefaultSharingLinkType ] + [-DefaultLinkPermission ] [-DefaultLinkToExistingAccess ] + [-DefaultLinkToExistingAccessReset] [-AnonymousLinkExpirationInDays ] + [-OverrideTenantAnonymousLinkExpirationPolicy ] [-ExternalUserExpirationInDays ] + [-OverrideTenantExternalUserExpirationPolicy ] [-InformationBarriersMode ] [-BlockDownloadLinksFileType ] - [-BlockDownloadPolicy ] - [-ClearRestrictedAccessControl ] - [-CommentsOnSitePagesDisabled ] - [-ConditionalAccessPolicy ] - [-DefaultLinkPermission ] - [-DefaultLinkToExistingAccess ] - [-DefaultShareLinkRole ] - [-DefaultShareLinkScope ] - [-DefaultSharingLinkType ] - [-DenyAddAndCustomizePages ] - [-DisableAppViews ] - [-DisableCompanyWideSharingLinks ] - [-DisableFlows ] - [-ExcludeBlockDownloadPolicySiteOwners ] - [-ExcludedBlockDownloadGroupIds [Guid[]]] - [-ExternalUserExpirationInDays ] - [-HidePeoplePreviewingFiles ] - [-HidePeopleWhoHaveListsOpen ] - [-HubSiteId ] - [-Identity ] - [-InformationBarriersMode ] - [-LimitedAccessFileType ] - [-LockState ] - [-LoopDefaultSharingLinkRole ] - [-LoopDefaultSharingLinkScope ] - [-MediaTranscription ] - [-OverrideBlockUserInfoVisibility ] - [-OverrideSharingCapability ] - [-OverrideTenantAnonymousLinkExpirationPolicy ] - [-OverrideTenantExternalUserExpirationPolicy ] - [-Owner ] - [-ReadOnlyForBlockDownloadPolicy ] - [-ReadOnlyForUnmanagedDevices ] - [-RemoveLabel ] - [-RemoveRestrictedAccessControlGroups [Guid[]]] - [-RequestFilesLinkEnabled ] - [-RequestFilesLinkExpirationInDays ] - [-ResourceQuotaWarningLevel ] - [-RestrictContentOrgWideSearch ] - [-RestrictedContentDiscoveryforCopilotAndAgents ] - [-RestrictedAccessControl ] - [-RestrictedAccessControlGroups [Guid[]]] - [-RestrictedToGeo ] - [-SandboxedCodeActivationCapability ] - [-SensitivityLabel ] - [-SharingAllowedDomainList ] - [-SharingBlockedDomainList ] - [-SharingCapability ] - [-SharingDomainRestrictionMode ] - [-ShowPeoplePickerSuggestionsForGuestUsers ] - [-SocialBarOnSitePagesDisabled ] - [-StorageQuota ] - [-StorageQuotaReset ] - [-StorageQuotaWarningLevel ] - [-Title ] + [-OverrideBlockUserInfoVisibility ] + [-LoopDefaultSharingLinkScope ] [-LoopDefaultSharingLinkRole ] + [-RequestFilesLinkEnabled ] [-RequestFilesLinkExpirationInDays ] + [-OverrideSharingCapability ] [-DefaultShareLinkScope ] + [-DefaultShareLinkRole ] [-BlockGuestsAsSiteAdmin ] + [-RestrictContentOrgWideSearch ] [-RestrictedContentDiscoveryforCopilotAndAgents ] + [-RestrictedAccessControl ] [-RestrictedAccessControlGroups ] + [-ListsShowHeaderAndNavigation ] [-HidePeoplePreviewingFiles ] + [-HidePeopleWhoHaveListsOpen ] [-AllowFileArchive ] + [-AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled ] [-WhatIf] [-Confirm] [] ``` ### ParamSet2 - -```powershell -Set-SPOSite [-Identity] [-EnablePWA ] [-Confirm] [-WhatIf] [] +``` +Set-SPOSite [-Identity] -EnablePWA [-InformationBarriersMode ] [-WhatIf] + [-Confirm] [] ``` ### ParamSet3 +``` +Set-SPOSite [-Identity] [-DisableSharingForNonOwners] [-InformationBarriersMode ] + [-WhatIf] [-Confirm] [] +``` -```powershell -Set-SPOSite [-Identity] [-Confirm] [-DisableSharingForNonOwners] [-WhatIf] - [] +### ParamSet5 +``` +Set-SPOSite [-Identity] [-RemoveLabel] [-InformationBarriersMode ] [-WhatIf] + [-Confirm] [] ``` -### ParamSet4 (valid for Group Site Collection) +### AddInformationBarrierSegments +``` +Set-SPOSite [-Identity] [-AddInformationSegment ] [-InformationBarriersMode ] + [-WhatIf] [-Confirm] [] +``` -```powershell -Set-SPOSite [-Identity] [-AllowSelfServiceUpgrade ] [-Confirm] - [-DenyAddAndCustomizePages ] [-LockState ] [-NoWait] [-Owner ] - [-ResourceQuotaWarningLevel ] - [-SandboxedCodeActivationCapability ] - [-SharingCapability ] [-StorageQuota ] [-StorageQuotaWarningLevel ] - [] +### RemoveInformationBarrierSegments +``` +Set-SPOSite [-Identity] [-RemoveInformationSegment ] + [-InformationBarriersMode ] [-WhatIf] [-Confirm] [] ``` -### SetSiteFileVersionPolicy +### ClearLockDown +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] [-ClearSharingLockDown] [-WhatIf] + [-Confirm] [] +``` -```powershell -Set-SPOSite [-Identity] - [-EnableAutoExpirationVersionTrim ] - [-MajorVersionLimit ] - [-MajorWithMinorVersionsLimit ] - [-ExpireVersionsAfterDays ] - [-ApplyToNewDocumentLibraries] - [-ApplyToExistingDocumentLibraries] - [-InheritVersionPolicyFromTenant] - [] +### AddRestrictedAccessControlGroups +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] + [-AddRestrictedAccessControlGroups ] [-WhatIf] [-Confirm] [] ``` -### ClearGroupId +### RemoveRestrictedAccessControlGroups +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] + [-RemoveRestrictedAccessControlGroups ] [-WhatIf] [-Confirm] [] +``` -```powershell -Set-SPOSite [-Identity] [-ClearGroupId] [] +### ClearRestrictedAccessControl +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] [-ClearRestrictedAccessControl] + [-WhatIf] [-Confirm] [] +``` + +### InheritVersionPolicyFromTenant +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] [-InheritVersionPolicyFromTenant] + [-WhatIf] [-Confirm] [] +``` + +### SetSiteFileVersionPolicy +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] + [-EnableAutoExpirationVersionTrim ] [-ExpireVersionsAfterDays ] [-MajorVersionLimit ] + [-MajorWithMinorVersionsLimit ] [-ApplyToNewDocumentLibraries] [-ApplyToExistingDocumentLibraries] + [-WhatIf] [-Confirm] [] +``` + +### ClearGroupId +``` +Set-SPOSite [-Identity] [-InformationBarriersMode ] [-ClearGroupId] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -140,7 +143,7 @@ For any parameters that are passed in, the `Set-SPOSite` cmdlet sets or updates You must be a SharePoint Online administrator and be a site collection administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). For OneDrive for Business site collection, the only valid parameters are Identity, AllowDownloadingNonWebViewableFiles, AllowEditing, ConditionalAccessPolicy, DefaultLinkPermission, DefaultSharingLinkType, DisableCompanyWideSharingLinks, LimitedAccessFileType, LockState, Owner, SharingAllowedDomainList, SharingBlockedDomainList, SharingCapability, SharingDomainRestrictionMode, ShowPeoplePickerSuggestionsForGuestUsers, StorageQuota, and StorageWarningLevel. @@ -314,47 +317,48 @@ Example 20 clears the file version setting at site level. The new document libra ## PARAMETERS -### -EnablePWA +### -AddInformationSegment -Determines whether site can include Project Web App. -For more information about Project Web App, see Plan SharePoint groups in Project Server. +This parameter allows you to add a segment to a SharePoint site. This parameter is only applicable for tenants who have enabled Microsoft 365 Information barriers capability. Please read https://learn.microsoft.com/sharepoint/information-barriers documentation to understand Information barriers in SharePoint Online. + +**Note**: This parameter is available only in SharePoint Online Management Shell Version 16.0.19927.12000 or later. ```yaml -Type: Boolean -Parameter Sets: ParamSet2 +Type: System.Guid[] +Parameter Sets: AddInformationBarrierSegments Aliases: -Applicable: SharePoint Online -Required: True + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -AddRestrictedAccessControlGroups -Specifies the URL of the site collection to update. +Specifies the IDs of groups to be added to an access restriction policy and gain access. ```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) +Type: System.Guid[] +Parameter Sets: AddRestrictedAccessControlGroups Aliases: Applicable: SharePoint Online -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSelfServiceUpgrade +### -AllowDownloadingNonWebViewableFiles -Determines whether site collection administrators can upgrade their site collections. +Specifies if non web viewable files can be downloaded. PARAMVALUE: False | True ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -365,30 +369,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled -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 - -```yaml -Type: Boolean -Parameter Sets: (All) -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +### -AllowEditing -### -Confirm +Prevents users from editing Office files in the browser and copying and pasting Office file contents out of the browser window. -Prompts you for confirmation before running the cmdlet. +PARAMVALUE: False | True ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: System.Boolean +Parameter Sets: ParamSet1 +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -397,15 +387,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DenyAddAndCustomizePages +### -AllowFileArchive -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. +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 +If set to True, the feature will be enable. Feature is disabled by default. + ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -416,34 +407,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableSharingForNonOwners - -This parameter prevents non-owners from inviting new users to the site. -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet3 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -AllowSelfServiceUpgrade -### -LockState +Determines whether site collection administrators can upgrade their site collections. -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. -When the lock state of a site is NoAccess, all traffic to the site will be blocked. -If parameter NoAccessRedirectUrl in the `Set-SPOTenant` cmdlet is set, traffic to sites that have a lock state NoAccess will be redirected to that URL. -If parameter NoAccessRedirectUrl is not set, a 403 error will be returned. -It isn't possible to set the lock state on the root site collection. +PARAMVALUE: False | True ```yaml -Type: String +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -454,32 +426,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaTranscription - -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: +### -AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled +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. -- Enabled -- Disabled +PARAMVALUE: True | False ```yaml -Type: MediaTranscriptionPolicyType +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NoWait +### -AnonymousLinkExpirationInDays -Specifies to continue executing script immediately. +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). ```yaml -Type: SwitchParameter +Type: System.Int32 Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -490,13 +461,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Owner +### -ApplyToExistingDocumentLibraries -Specifies the owner of the site collection. Changing the Owner of a OneDrive is not supported and causes many experiences to break. +Create a job to apply the version history limits setting to existing document libraries. ```yaml -Type: String -Parameter Sets: ParamSet1 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetSiteFileVersionPolicy Aliases: Applicable: SharePoint Online Required: False @@ -506,13 +477,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceQuotaWarningLevel +### -ApplyToNewDocumentLibraries -Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the resource quota. +Apply the version history limits setting to new document libraries. ```yaml -Type: Double -Parameter Sets: ParamSet1 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: SetSiteFileVersionPolicy Aliases: Applicable: SharePoint Online Required: False @@ -522,30 +493,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictedAccessControl - -Sets access restriction policy by group membership. - -PARAMVALUE: False | True +### -AuthenticationContextAccessType -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +Controls whether Authentication Context Limited Access is enabled for a site. -### -SensitivityLabel +The valid values are: -Used to specify the unique identifier (GUID) of the SensitivityLabel. +- AllowLimitedAccess +- BlockAccess ```yaml -Type: String +Type: Microsoft.Online.SharePoint.TenantManagement.SPOAuthenticationContextPolicyAccessType Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -556,12 +514,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SandboxedCodeActivationCapability +### -AuthenticationContextName -PARAMVALUE: Unknown | Check | Disabled | Enabled +The conditional access authentication context name. ```yaml -Type: SandboxedCodeActivationCapabilities +Type: System.String Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -584,32 +542,27 @@ The valid values are: The site's value is compared with the tenant level setting and the stricter one wins. For example, if the tenant is set to ServerRenderedFilesOnly then that will be used even if the site is set to WebPreviewableFiles. ```yaml -Type: BlockDownloadLinksFileTypes -Parameter Sets: (All) +Type: Microsoft.Online.SharePoint.TenantManagement.BlockDownloadLinksFileTypes +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: WebPreviewableFiles +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingCapability - -Determines what level of sharing is available for the site. +### -BlockDownloadPolicy -The valid values are: +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. -- Disabled - Sharing outside your organization is disabled. -- ExistingExternalUserSharingOnly - Allow sharing only with the external users that already exist in your organization's directory. -- ExternalUserSharingOnly - External user sharing (share by email) is enabled, but anonymous link sharing is disabled. -- ExternalUserAndGuestSharing - External user sharing (share by email) and anonymous link sharing are both enabled. +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). -For more information about sharing, see Turn external sharing on or off for SharePoint Online (). +PARAMVALUE: False | True ```yaml -Type: SharingCapabilities +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -620,15 +573,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageQuota - -Specifies the storage quota in megabytes of the site collection. +### -BlockGuestsAsSiteAdmin +{{ Fill BlockGuestsAsSiteAdmin Description }} ```yaml -Type: Int64 +Type: Microsoft.SharePoint.Client.SharingState Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -636,15 +588,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageQuotaWarningLevel +### -ClearGroupId -Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the storage quota. +This parameter allows you to remove the assigned Microsoft 365 group ID on a site, when the group is permanently deleted. ```yaml -Type: Int64 -Parameter Sets: ParamSet1 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearGroupId Aliases: -Applicable: SharePoint Online Required: False Position: Named Default value: None @@ -652,13 +603,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Title +### -ClearRestrictedAccessControl -Specifies the title of the site collection. +Clears the list of groups that are given access via an access restriction policy. ```yaml -Type: String -Parameter Sets: ParamSet1 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearRestrictedAccessControl Aliases: Applicable: SharePoint Online Required: False @@ -668,15 +619,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf - -The WhatIf switch doesn't work on this cmdlet. +### -ClearSharingLockDown +{{ Fill ClearSharingLockDown Description }} ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ClearLockDown +Aliases: + Required: False Position: Named Default value: None @@ -684,14 +634,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDownloadingNonWebViewableFiles +### -CommentsOnSitePagesDisabled -Specifies if non web viewable files can be downloaded. +Use this parameter to disable Comments section on Site Pages. +The parameter can't be used for Groups Site Collections. PARAMVALUE: False | True ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -702,15 +653,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CommentsOnSitePagesDisabled +### -ConditionalAccessPolicy -Use this parameter to disable Comments section on Site Pages. -The parameter can't be used for Groups Site Collections. +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: False | True +Possible values: + +- AllowFullAccess: Allows full access from desktop apps, mobile apps, and the web. +- AllowLimitedAccess: Allows limited, web-only access. +- BlockAccess: Blocks Access. +- AuthenticationContext: Assign a Microsoft Entra authentication context. Must add the AuthenticationContextName. Please read [Configure authentication contexts](/azure/active-directory/conditional-access/concept-conditional-access-cloud-apps#configure-authentication-contexts). ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SPOConditionalAccessPolicyType Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -721,39 +676,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SocialBarOnSitePagesDisabled +### -DefaultLinkPermission -Disables or enables the Social Bar for Site Collection. +The default link permission for the site collection. To be replaced by DefaultShareLinkRole. -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. +PARAMVALUE: None | View | Edit -PARAMVALUE: False | True +- None - Respect the organization default link permission +- View - Sets the default link permission for the site to "view" permissions +- Edit - Sets the default link permission for the site to "edit" permissions ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SharingPermissionType Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableAppViews +### -DefaultLinkToExistingAccess -**Note**: This parameter has been retired and no longer functions. +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. -Disables the Power Apps button. -Possible values: - -- Disabled -- NotDisabled -- Unknown (not settable) +PARAMVALUE: False | True ```yaml -Type: AppViewsPolicy +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -764,18 +716,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableCompanyWideSharingLinks +### -DefaultLinkToExistingAccessReset +{{ Fill DefaultLinkToExistingAccessReset Description }} -Disables People in your organization links. For more information, see [People in your organization sharing links](https://learn.microsoft.com/microsoft-365/solutions/microsoft-365-limit-sharing#people-in-your-organization-sharing-links). +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ParamSet1 +Aliases: -Possible values +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- Disabled -- NotDisabled -- Unknown (not settable) +### -DefaultShareLinkRole + +The default share link role for the site collection. It replaces `DefaultLinkPermission`. + +The valid values are: + +- Edit +- None +- RestrictedView +- Review +- View ```yaml -Type: CompanyWideSharingLinksPolicy +Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -786,18 +755,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableFlows +### -DefaultShareLinkScope -**Note**: This parameter has been retired and no longer functions. +The default share link scope on the site. It replaces `DefaultSharingLinkType`. -Disables the Power Automate button. -Possible values +The valid values are: -- Disabled -- NotDisabled +- Anyone +- Organization +- SpecificPeople +- Uninitialized ```yaml -Type: FlowsPolicy +Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -808,12 +778,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictedToGeo +### -DefaultSharingLinkType -PARAMVALUE: NoRestriction | BlockMoveOnly | BlockFull | Unknown +The default link type for the site collection. To be replaced by DefaultShareLinkScope. + +PARAMVALUE: None | AnonymousAccess | Internal | Direct + +- None - Respect the organization default sharing link type +- AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link +- Internal - Sets the default sharing link for this site to the "organization" link or company shareable link +- Direct - Sets the default sharing link for this site to the "Specific people" link ```yaml -Type: RestrictedToRegion +Type: Microsoft.Online.SharePoint.TenantManagement.SharingLinkType Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -824,14 +801,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingAllowedDomainList +### -DenyAddAndCustomizePages -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". +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. -For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](https://learn.microsoft.com/sharepoint/restricted-domains-sharing). +PARAMVALUE: False | True ```yaml -Type: String +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -842,14 +820,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingBlockedDomainList +### -DisableAppViews -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". +**Note**: This parameter has been retired and no longer functions. + +Disables the Power Apps button. +Possible values: -For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](https://learn.microsoft.com/sharepoint/restricted-domains-sharing). +- Disabled +- NotDisabled +- Unknown (not settable) ```yaml -Type: String +Type: Microsoft.Online.SharePoint.TenantAdministration.AppViewsPolicy Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -860,20 +843,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingDomainRestrictionMode - -Specifies the sharing mode for external domains. +### -DisableCompanyWideSharingLinks -Possible values are: +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). -- None - Do not restrict sharing by domain -- AllowList - Sharing is allowed only with external users that have account on domains specified with -SharingAllowedDomainList -- BlockList - Sharing is allowed with external users in all domains except in domains specified with -SharingBlockedDomainList +Possible values -For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](https://learn.microsoft.com/sharepoint/restricted-domains-sharing). +- Disabled +- NotDisabled +- Unknown (not settable) ```yaml -Type: SharingDomainRestrictionModes +Type: Microsoft.Online.SharePoint.TenantAdministration.CompanyWideSharingLinksPolicy Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -884,31 +865,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowPeoplePickerSuggestionsForGuestUsers +### -DisableFlows -To enable the option to search for existing guest users at site collection level, set this parameter to $true. +**Note**: This parameter has been retired and no longer functions. -PARAMVALUE: False | True +Disables the Power Automate button. +Possible values + +- Disabled +- NotDisabled ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantAdministration.FlowsPolicy Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StorageQuotaReset +### -DisableSharingForNonOwners -Resets the OneDrive for Business storage quota to the tenant's new default storage space. +This parameter prevents non-owners from inviting new users to the site. ```yaml -Type: SwitchParameter -Parameter Sets: ParamSet1 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ParamSet3 Aliases: Applicable: SharePoint Online Required: False @@ -918,20 +903,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultSharingLinkType +### -EnableAutoExpirationVersionTrim -The default link type for the site collection. To be replaced by DefaultShareLinkScope. +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. -PARAMVALUE: None | AnonymousAccess | Internal | Direct +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. -- None - Respect the organization default sharing link type -- AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link -- Internal - Sets the default sharing link for this site to the "organization" link or company shareable link -- Direct - Sets the default sharing link for this site to the "Specific people" link +The valid values are: + +- True - Version history limits for new versions created on new/existing document libraries in the site will be managed automatically. +- False - Version history limits for new Versions created on new/existing document libraries in the site will be managed manually by setting limits to the number of major versions (`MajorVersionLimit`), number of major with minor versions (`MajorWithMinorVersionsLimit`) and time set (`ExpireVersionsAfterDays`). Review the documentation of both parameters to manage your organization's version limits manually. + +> [!NOTE] +> When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), `MajorVersionLimit` and `ExpireVersionsAfterDays` are both required parameters, `MajorWithMinorVersionsLimit` is also required for creating request for setting existing document libraries with the following acceptable values: +> a. `MajorVersionLimit` accepts values from 1 through 50,000 (inclusive). +> b. `MajorWithMinorVersionsLimit` accepts values from 0 through 50,000 (inclusive). +> c. `ExpireVersionsAfterDays` accepts values of 0 to Never Expire or values >= 30 to delete versions that exceed that time period. +> When version history limits are managed automatically (`EnableAutoExpirationVersionTrim $true`), setting `MajorVersionLimit` or `ExpireVersionsAfterDays` will result in an error as the count limits are set by the service. + +PARAMVALUE: False | True ```yaml -Type: SharingLinkType -Parameter Sets: ParamSet1 +Type: System.Boolean +Parameter Sets: SetSiteFileVersionPolicy Aliases: Applicable: SharePoint Online Required: False @@ -941,14 +935,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultLinkToExistingAccess +### -EnablePWA -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. +Determines whether site can include Project Web App. +For more information about Project Web App, see Plan SharePoint groups in Project Server. + +```yaml +Type: System.Boolean +Parameter Sets: ParamSet2 +Aliases: +Applicable: SharePoint Online +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeBlockDownloadPolicySiteOwners + +Controls if site owners are excluded from block download policy. PARAMVALUE: False | True ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -959,18 +970,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultLinkPermission +### -ExcludeBlockDownloadSharePointGroups -The default link permission for the site collection. To be replaced by DefaultShareLinkRole. +Specifies the groups excluded from the block download policy. -PARAMVALUE: None | View | Edit +```yaml +Type: System.String[] +Parameter Sets: ParamSet1 +Aliases: +Applicable: SharePoint Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- None - Respect the organization default link permission -- View - Sets the default link permission for the site to "view" permissions -- Edit - Sets the default link permission for the site to "edit" permissions +### -ExcludedBlockDownloadGroupIds + +Exempts users from specified groups from the block download policy and they can fully download any content for the site. ```yaml -Type: SharingPermissionType +Type: System.Guid[] Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -981,44 +1002,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoopDefaultSharingLinkScope - -Gets or sets default share link scope for fluid on the site. +### -ExpireVersionsAfterDays -The valid values are: +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. -- Anyone -- Organization -- SpecificPeople -- Uninitialized +PARAMVALUE: Int32 ```yaml -Type: SharingScope -Parameter Sets: (All) +Type: System.Int32 +Parameter Sets: SetSiteFileVersionPolicy Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Uninitialized +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LoopDefaultSharingLinkRole - -Gets or sets default share link role for fluid on the site. +### -ExternalUserExpirationInDays -The valid values are: +Specifies all external user expiration which will expire after the set number of days. Only applies if OverrideTenantExternalUserExpirationPolicy is set to true. -- Edit -- None -- RestrictedView -- Review -- View +The maximum value is 730. To remove the expiration requirement, set the value to zero (0). ```yaml -Type: SharingRole -Parameter Sets: (All) +Type: System.Int32 +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1028,18 +1038,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideTenantAnonymousLinkExpirationPolicy +### -HidePeoplePreviewingFiles -Choose whether to override the anonymous or anyone link expiration policy on this site. +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: None | False | True +PARAMVALUE: False | True -- None - Respect the organization-level policy for anonymous or anyone link expiration -- False - Respect the organization-level policy for anonymous or anyone link expiration -- True - Override the organization-level policy for anonymous or anyone link expiration (can be more or less restrictive) +If set to True, the presence of other users on the file will no longer be displayed. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1050,15 +1058,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AnonymousLinkExpirationInDays +### -HidePeopleWhoHaveListsOpen -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. +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. -The valid number should be between 1 and 730. To remove the expiration requirement, set the value to zero (0). +PARAMVALUE: False | True + +If set to True, the presence of other users on the list and its items will no longer be displayed. List presence is enabled by default. ```yaml -Type: Int32 -Parameter Sets: (All) +Type: System.Boolean +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1068,18 +1078,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideTenantExternalUserExpirationPolicy - -Choose whether to override the external user expiration policy on this site. - -Possible values: +### -HubSiteId -- None: Respect the organization-level policy for external user expiration. -- False: Respect the organization-level policy for external user expiration. -- True: Override the organization-level policy for external user expiration (can be more or less restrictive). +Sets the hub site for a specified SharePoint site. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1090,14 +1094,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalUserExpirationInDays +### -Identity -Specifies all external user expiration which will expire after the set number of days. Only applies if OverrideTenantExternalUserExpirationPolicy is set to true. +Specifies the URL of the site collection to update. -The maximum value is 730. To remove the expiration requirement, set the value to zero (0). +```yaml +Type: SpoSitePipeBind +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InformationBarriersMode + +Specifies the information barrier mode. ```yaml -Type: Int32 +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1108,15 +1126,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestFilesLinkEnabled - -Enables or disables the Request Files link on the site. +### -InheritVersionPolicyFromTenant -PARAMVALUE: False | True +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: Boolean -Parameter Sets: ParamSet1 +Type: System.Management.Automation.SwitchParameter +Parameter Sets: InheritVersionPolicyFromTenant Aliases: Applicable: SharePoint Online Required: False @@ -1126,53 +1142,71 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestFilesLinkExpirationInDays +### -LimitedAccessFileType -Specifies the number of days before a Request Files link expires for the site. +The following parameters can be used with -ConditionalAccessPolicy AllowLimitedAccess for both the organization-wide setting and the site-level setting. -The value can be from 0 to 730 days. +- OfficeOnlineFilesOnly: Allows users to preview only Office files in the browser. This option increases security but may be a barrier to user productivity. + +- LimitedAccessFileType WebPreviewableFiles (default): Allows users to preview Office files and other file types (such as PDF files and images) in the browser. Note that the contents of file types other than Office files are handled in the browser. This option optimizes for user productivity but offers less security for files that aren't Office files. + +- LimitedAccessFileType OtherFiles: Allows users to download files that can't be previewed, such as .zip and .exe. This option offers less security. ```yaml -Type: Int32 -Parameter Sets: (All) +Type: Microsoft.Online.SharePoint.TenantManagement.SPOLimitedAccessFileType +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: -1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConditionalAccessPolicy +### -ListsShowHeaderAndNavigation +{{ Fill ListsShowHeaderAndNavigation Description }} -Please read [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices) documentation here to understand Conditional Access Policy usage in SharePoint Online. +```yaml +Type: System.Boolean +Parameter Sets: ParamSet1 +Aliases: -Possible values: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- AllowFullAccess: Allows full access from desktop apps, mobile apps, and the web. -- AllowLimitedAccess: Allows limited, web-only access. -- BlockAccess: Blocks Access. -- AuthenticationContext: Assign a Microsoft Entra authentication context. Must add the AuthenticationContextName. Please read [Configure authentication contexts](/azure/active-directory/conditional-access/concept-conditional-access-cloud-apps#configure-authentication-contexts). +### -LocaleId +Specifies the language of this site collection. +For more information, see Locale IDs Assigned by Microsoft (https://go.microsoft.com/fwlink/p/?LinkId=242911) (https://go.microsoft.com/fwlink/p/?LinkId=242911). ```yaml -Type: SPOConditionalAccessPolicyType +Type: System.UInt32 Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: AllowFullAccess +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthenticationContextName +### -LockState -The conditional access authentication context name. +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. +When the lock state of a site is NoAccess, all traffic to the site will be blocked. +If parameter NoAccessRedirectUrl in the `Set-SPOTenant` cmdlet is set, traffic to sites that have a lock state NoAccess will be redirected to that URL. +If parameter NoAccessRedirectUrl is not set, a 403 error will be returned. +It isn't possible to set the lock state on the root site collection. ```yaml -Type: String +Type: System.String Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1183,80 +1217,102 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEditing +### -LoopDefaultSharingLinkRole -Prevents users from editing Office files in the browser and copying and pasting Office file contents out of the browser window. +Gets or sets default share link role for fluid on the site. -PARAMVALUE: False | True +The valid values are: + +- Edit +- None +- RestrictedView +- Review +- View ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitedAccessFileType - -The following parameters can be used with -ConditionalAccessPolicy AllowLimitedAccess for both the organization-wide setting and the site-level setting. +### -LoopDefaultSharingLinkScope -- OfficeOnlineFilesOnly: Allows users to preview only Office files in the browser. This option increases security but may be a barrier to user productivity. +Gets or sets default share link scope for fluid on the site. -- LimitedAccessFileType WebPreviewableFiles (default): Allows users to preview Office files and other file types (such as PDF files and images) in the browser. Note that the contents of file types other than Office files are handled in the browser. This option optimizes for user productivity but offers less security for files that aren't Office files. +The valid values are: -- LimitedAccessFileType OtherFiles: Allows users to download files that can't be previewed, such as .zip and .exe. This option offers less security. +- Anyone +- Organization +- SpecificPeople +- Uninitialized ```yaml -Type: SPOLimitedAccessFileType +Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: WebPreviewableFiles +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AddInformationSegment +### -MajorVersionLimit -This parameter allows you to add a segment to a SharePoint site. This parameter is only applicable for tenants who have enabled Microsoft 365 Information barriers capability. Please read https://learn.microsoft.com/sharepoint/information-barriers documentation to understand Information barriers in 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. -**Note**: This parameter is available only in SharePoint Online Management Shell Version 16.0.19927.12000 or later. +PARAMVALUE: Int32 ```yaml -Type: GUID +Type: System.Int32 +Parameter Sets: SetSiteFileVersionPolicy +Aliases: +Applicable: SharePoint Online Required: False Position: Named Default value: None +Accept pipeline input: False +Accept wildcard characters: False ``` -### -RemoveInformationSegment +### -MajorWithMinorVersionsLimit -This parameter allows you to remove a segment from a SharePoint site. This parameter is only applicable for tenants who have enabled Microsoft 365 Information barriers capability. Please read https://learn.microsoft.com/sharepoint/information-barriers documentation to understand Information barriers with 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. -**Note**: This parameter is available only in SharePoint Online Management Shell Version 16.0.19927.12000 or later. +PARAMVALUE: Int32 ```yaml -Type: GUID +Type: System.Int32 +Parameter Sets: SetSiteFileVersionPolicy +Aliases: +Applicable: SharePoint Online Required: False Position: Named Default value: None +Accept pipeline input: False +Accept wildcard characters: False ``` -### -RemoveLabel +### -MediaTranscription -This parameter allows you to remove the assigned sensitivity label on a site. +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: + +- Enabled +- Disabled ```yaml -Type: SwitchParameter -Parameter Sets: ParamSet5 +Type: Microsoft.Online.SharePoint.TenantManagement.MediaTranscriptionPolicyType +Parameter Sets: ParamSet1 Aliases: +Applicable: SharePoint Online Required: False Position: Named Default value: None @@ -1264,22 +1320,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockDownloadPolicy - -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](https://learn.microsoft.com/sharepoint/block-download-from-sites). +### -NoWait -PARAMVALUE: False | True +Specifies to continue executing script immediately. ```yaml -Type: Boolean +Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -1289,52 +1341,77 @@ Accept wildcard characters: False Choose whether to override the Block User Info Visibility policy on this site. PARAMVALUE: - - OrganizationDefault (default) - Respect the organization-level Block User Info Visibility policy. - - ApplyToNoUsers – No users are prevented from accessing User Info when they have Limited Access permission only on the site. - - ApplyToAllUsers – All users (internal or external) are prevented from accessing User Info if they have Limited Access permission only on the site. - - ApplyToGuestAndExternalUsers – Only external or guest users are prevented from accessing User Info if they have Limited Access permission only on the site. - - ApplyToInternalUsers – Only internal users are prevented from accessing User Info if they have Limited Access permission only on the site. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.TenantAdministration.SiteUserInfoVisibilityPolicyValue Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: OrganizationDefault +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAutoExpirationVersionTrim +### -OverrideSharingCapability -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. +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`. -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. +PARAMVALUE: False | True -The valid values are: +```yaml +Type: System.Boolean +Parameter Sets: ParamSet1 +Aliases: +Applicable: SharePoint Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- True - Version history limits for new versions created on new/existing document libraries in the site will be managed automatically. -- False - Version history limits for new Versions created on new/existing document libraries in the site will be managed manually by setting limits to the number of major versions (`MajorVersionLimit`), number of major with minor versions (`MajorWithMinorVersionsLimit`) and time set (`ExpireVersionsAfterDays`). Review the documentation of both parameters to manage your organization's version limits manually. +### -OverrideTenantAnonymousLinkExpirationPolicy -> [!NOTE] -> When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), `MajorVersionLimit` and `ExpireVersionsAfterDays` are both required parameters, `MajorWithMinorVersionsLimit` is also required for creating request for setting existing document libraries with the following acceptable values: -> a. `MajorVersionLimit` accepts values from 1 through 50,000 (inclusive). -> b. `MajorWithMinorVersionsLimit` accepts values from 0 through 50,000 (inclusive). -> c. `ExpireVersionsAfterDays` accepts values of 0 to Never Expire or values >= 30 to delete versions that exceed that time period. -> When version history limits are managed automatically (`EnableAutoExpirationVersionTrim $true`), setting `MajorVersionLimit` or `ExpireVersionsAfterDays` will result in an error as the count limits are set by the service. +Choose whether to override the anonymous or anyone link expiration policy on this site. -PARAMVALUE: False | True +PARAMVALUE: None | False | True + +- None - Respect the organization-level policy for anonymous or anyone link expiration +- False - Respect the organization-level policy for anonymous or anyone link expiration +- True - Override the organization-level policy for anonymous or anyone link expiration (can be more or less restrictive) + +```yaml +Type: System.Boolean +Parameter Sets: ParamSet1 +Aliases: +Applicable: SharePoint Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverrideTenantExternalUserExpirationPolicy + +Choose whether to override the external user expiration policy on this site. + +Possible values: + +- None: Respect the organization-level policy for external user expiration. +- False: Respect the organization-level policy for external user expiration. +- True: Override the organization-level policy for external user expiration (can be more or less restrictive). ```yaml -Type: Boolean -Parameter Sets: SetSiteFileVersionPolicy +Type: System.Boolean +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1344,15 +1421,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MajorVersionLimit - -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. +### -Owner -PARAMVALUE: Int32 +Specifies the owner of the site collection. Changing the Owner of a OneDrive is not supported and causes many experiences to break. ```yaml -Type: Int32 -Parameter Sets: SetSiteFileVersionPolicy +Type: System.String +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1362,15 +1437,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MajorWithMinorVersionsLimit +### -ReadOnlyForBlockDownloadPolicy -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. +Controls if read-only should be enabled for block download policy. -PARAMVALUE: Int32 +PARAMVALUE: False | True ```yaml -Type: Int32 -Parameter Sets: SetSiteFileVersionPolicy +Type: System.Boolean +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1380,17 +1455,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExpireVersionsAfterDays +### -ReadOnlyForUnmanagedDevices -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. +Controls whether unmanaged devices have read-only access. -PARAMVALUE: Int32 +PARAMVALUE: False | True ```yaml -Type: Int32 -Parameter Sets: SetSiteFileVersionPolicy +Type: System.Boolean +Parameter Sets: ParamSet1 Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1398,15 +1473,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplyToNewDocumentLibraries +### -RemoveInformationSegment -Apply the version history limits setting to new document libraries. +This parameter allows you to remove a segment from a SharePoint site. This parameter is only applicable for tenants who have enabled Microsoft 365 Information barriers capability. Please read https://learn.microsoft.com/sharepoint/information-barriers documentation to understand Information barriers with SharePoint Online. + +**Note**: This parameter is available only in SharePoint Online Management Shell Version 16.0.19927.12000 or later. ```yaml -Type: Int32 -Parameter Sets: SetSiteFileVersionPolicy +Type: System.Guid[] +Parameter Sets: RemoveInformationBarrierSegments Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1414,15 +1491,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplyToExistingDocumentLibraries +### -RemoveLabel -Create a job to apply the version history limits setting to existing document libraries. +This parameter allows you to remove the assigned sensitivity label on a site. ```yaml -Type: Int32 -Parameter Sets: SetSiteFileVersionPolicy +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ParamSet5 Aliases: -Applicable: SharePoint Online Required: False Position: Named Default value: None @@ -1430,13 +1506,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InheritVersionPolicyFromTenant +### -RemoveRestrictedAccessControlGroups -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. +Specifies the IDs of groups to be removed from access restriction policy and lose access. ```yaml -Type: Int32 -Parameter Sets: SetSiteFileVersionPolicy +Type: System.Guid[] +Parameter Sets: RemoveRestrictedAccessControlGroups Aliases: Applicable: SharePoint Online Required: False @@ -1446,14 +1522,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideSharingCapability +### -RequestFilesLinkEnabled -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`. +Enables or disables the Request Files link on the site. PARAMVALUE: False | True ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1464,44 +1540,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultShareLinkScope - -The default share link scope on the site. It replaces `DefaultSharingLinkType`. +### -RequestFilesLinkExpirationInDays -The valid values are: +Specifies the number of days before a Request Files link expires for the site. -- Anyone -- Organization -- SpecificPeople -- Uninitialized +The value can be from 0 to 730 days. ```yaml -Type: SharingScope -Parameter Sets: (All) +Type: System.Int32 +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Uninitialized +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultShareLinkRole +### -ResourceQuota +Specifies the resource quota in megabytes of the site collection. +The default value is 0. +For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010 (https://msdn.microsoft.com/en-us/library/gg615462.aspx) (https://msdn.microsoft.com/en-us/library/gg615462.aspx). -The default share link role for the site collection. It replaces `DefaultLinkPermission`. +```yaml +Type: System.Double +Parameter Sets: ParamSet1 +Aliases: -The valid values are: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- Edit -- None -- RestrictedView -- Review -- View +### -ResourceQuotaWarningLevel + +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: SharingRole -Parameter Sets: (All) +Type: System.Double +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1511,75 +1591,67 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HidePeoplePreviewingFiles +### -RestrictContentOrgWideSearch -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. +Controls whether org-wide content search is enabled for a site. PARAMVALUE: False | True -If set to True, the presence of other users on the file will no longer be displayed. - ```yaml -Type: Boolean -Parameter Sets: (All) +Type: System.Boolean +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HidePeopleWhoHaveListsOpen +### -RestrictedAccessControl -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. +Sets access restriction policy by group membership. PARAMVALUE: False | True -If set to True, the presence of other users on the list and its items will no longer be displayed. List presence is enabled by default. - ```yaml -Type: Boolean -Parameter Sets: (All) +Type: System.Boolean +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFileArchive - -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 +### -RestrictedAccessControlGroups -If set to True, the feature will be enable. Feature is disabled by default. +Specifies the IDs of groups that have access under an access restriction policy. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: System.Guid[] +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -RestrictedContentDiscoveryforCopilotAndAgents -### -ClearGroupId - -This parameter allows you to remove the assigned Microsoft 365 group ID on a site, when the group is permanently deleted. +Sets or updates the site setting to host Agents by activating or deactivating the Restricted Content Discovery (RCD) for Agents. *Currently under private preview.* ```yaml -Type: SwitchParameter -Parameter Sets: ClearGroupId +Type: System.Boolean +Parameter Sets: ParamSet1 Aliases: + Required: False Position: Named Default value: None @@ -1587,30 +1659,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReadOnlyForUnmanagedDevices - -Controls whether unmanaged devices have read-only access. +### -RestrictedToGeo -PARAMVALUE: False | True +PARAMVALUE: NoRestriction | BlockMoveOnly | BlockFull | Unknown ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Microsoft.Online.SharePoint.TenantAdministration.RestrictedToRegion +Parameter Sets: ParamSet1 +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedBlockDownloadGroupIds +### -SandboxedCodeActivationCapability -Exempts users from specified groups from the block download policy and they can fully download any content for the site. +PARAMVALUE: Unknown | Check | Disabled | Enabled ```yaml -Type: Guid[] -Parameter Sets: (All) +Type: Microsoft.Online.SharePoint.TenantAdministration.SandboxedCodeActivationCapabilities +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1620,48 +1691,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeBlockDownloadPolicySiteOwners - -Controls if site owners are excluded from block download policy. +### -SensitivityLabel -PARAMVALUE: False | True +Used to specify the unique identifier (GUID) of the SensitivityLabel. ```yaml -Type: Boolean +Type: System.String Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReadOnlyForBlockDownloadPolicy +### -SharingAllowedDomainList -Controls if read-only should be enabled for block download policy. +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". -PARAMVALUE: False | True +For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](/sharepoint/restricted-domains-sharing). ```yaml -Type: Boolean +Type: System.String Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeBlockDownloadSharePointGroups +### -SharingBlockedDomainList -Specifies the groups excluded from the block download policy. +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). ```yaml -Type: String +Type: System.String Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1672,17 +1743,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthenticationContextAccessType +### -SharingCapability -Controls whether Authentication Context Limited Access is enabled for a site. +Determines what level of sharing is available for the site. The valid values are: -- AllowLimitedAccess -- BlockAccess +- Disabled - Sharing outside your organization is disabled. +- ExistingExternalUserSharingOnly - Allow sharing only with the external users that already exist in your organization's directory. +- ExternalUserSharingOnly - External user sharing (share by email) is enabled, but anonymous link sharing is disabled. +- ExternalUserAndGuestSharing - External user sharing (share by email) and anonymous link sharing are both enabled. + +For more information about sharing, see Turn external sharing on or off for SharePoint Online (). ```yaml -Type: SPOAuthenticationContextPolicyAccessType +Type: Microsoft.Online.SharePoint.TenantManagement.SharingCapabilities Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1693,12 +1768,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HubSiteId +### -SharingDomainRestrictionMode -Sets the hub site for a specified SharePoint site. +Specifies the sharing mode for external domains. + +Possible values are: + +- None - Do not restrict sharing by domain +- AllowList - Sharing is allowed only with external users that have account on domains specified with -SharingAllowedDomainList +- BlockList - Sharing is allowed with external users in all domains except in domains specified with -SharingBlockedDomainList + +For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](/sharepoint/restricted-domains-sharing). ```yaml -Type: GUID +Type: Microsoft.Online.SharePoint.TenantManagement.SharingDomainRestrictionModes Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1709,12 +1792,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InformationBarriersMode +### -ShowPeoplePickerSuggestionsForGuestUsers -Specifies the information barrier mode. +To enable the option to search for existing guest users at site collection level, set this parameter to $true. + +PARAMVALUE: False | True ```yaml -Type: String +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online @@ -1725,31 +1810,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictContentOrgWideSearch +### -SocialBarOnSitePagesDisabled -Controls whether org-wide content search is enabled for a site. +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. PARAMVALUE: False | True ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictedAccessControlGroups +### -StorageQuota -Specifies the IDs of groups that have access under an access restriction policy. +Specifies the storage quota in megabytes of the site collection. ```yaml -Type: Guid[] -Parameter Sets: (All) +Type: System.Int64 +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1759,13 +1846,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AddRestrictedAccessControlGroups +### -StorageQuotaReset -Specifies the IDs of groups to be added to an access restriction policy and gain access. +Resets the OneDrive for Business storage quota to the tenant's new default storage space. ```yaml -Type: Guid[] -Parameter Sets: (All) +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1775,13 +1862,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoveRestrictedAccessControlGroups +### -StorageQuotaWarningLevel -Specifies the IDs of groups to be removed from access restriction policy and lose access. +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: Guid[] -Parameter Sets: (All) +Type: System.Int64 +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1791,13 +1878,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClearRestrictedAccessControl +### -Title -Clears the list of groups that are given access via an access restriction policy. +Specifies the title of the site collection. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: System.String +Parameter Sets: ParamSet1 Aliases: Applicable: SharePoint Online Required: False @@ -1807,12 +1894,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictedContentDiscoveryforCopilotAndAgents - -Sets or updates the site setting to host Agents by activating or deactivating the Restricted Content Discovery (RCD) for Agents. *Currently under private preview.* +### -UpdateUserTypeFromAzureAD +{{ Fill UpdateUserTypeFromAzureAD Description }} ```yaml -Type: Boolean +Type: System.Management.Automation.SwitchParameter Parameter Sets: ParamSet1 Aliases: @@ -1823,6 +1909,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -1835,6 +1953,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Set-SPOTenant](Set-SPOTenant.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteArchiveState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md similarity index 52% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteArchiveState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md index 5091a48cb..a012f8318 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteArchiveState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteArchiveState.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spositearchivestate applicable: SharePoint Online @@ -18,8 +18,9 @@ Sets the archived state of the site. Can be used to archive and reactivate sites ## SYNTAX -```powershell -Set-SPOSiteArchiveState [-Identity] -ArchiveState [-Confirm] [-WhatIf] [] +``` +Set-SPOSiteArchiveState [-Identity] [-ArchiveState] [-NoWait] [-Force] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -52,17 +53,106 @@ This example triggers the reactivation of a site. If the site is reactivated fro Sets the archived state of the site. Valid values are Archived, Active. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SPOArchiveState +Parameter Sets: (All) +Aliases: +Accepted values: Archived, Active Applicable: SharePoint Online Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +{{ Fill Identity Description }} + +```yaml +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NoWait +{{ Fill NoWait Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteDesign.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteDesign.md index 07027ebdc..3b51f7abb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteDesign.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spositedesign applicable: SharePoint Online @@ -18,19 +18,15 @@ Updates a previously uploaded site design. ## SYNTAX -```powershell -Set-SPOSiteDesign - [-Identity ] - [-Title ] - [-WebTemplate ] - [-SiteScripts ] - [-Description ] - [-ThumbnailUrl ] - [-PreviewImageUrl ] - [-PreviewImageAltText ] - [-IsDefault] - [] ``` +Set-SPOSiteDesign [-Identity] [-Title ] [-WebTemplate ] + [-SiteScripts ] [-Description ] [-ThumbnailUrl ] + [-PreviewImageUrl ] [-PreviewImageAltText ] [-IsDefault ] [-Version ] + [-DesignPackageId ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} ## EXAMPLES @@ -55,28 +51,59 @@ Updates a previously uploaded site design. ## PARAMETERS +### -Description + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DesignPackageId +{{ Fill DesignPackageId Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity The site design Id. ```yaml -Type: SPOSiteDesignPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Title +### -IsDefault -The display name of the site design. +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: String +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -87,12 +114,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebTemplate +### -PreviewImageAltText -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. +The alt text description of the image for accessibility. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -103,12 +130,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteScripts +### -PreviewImageUrl -An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. +The URL of a preview image. If none is specified, SharePoint uses a generic image. ```yaml -Type: SPOSiteScriptPipeBind[] +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -119,12 +146,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -SiteScripts -The display description of the site design. +An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -140,7 +167,7 @@ Accept wildcard characters: False The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -151,12 +178,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreviewImageUrl +### -Title -The URL of a preview image. If none is specified, SharePoint uses a generic image. +The display name of the site design. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -167,15 +194,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreviewImageAltText - -The alt text description of the image for accessibility. +### -Version +{{ Fill Version Description }} ```yaml -Type: String +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -183,12 +209,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsDefault +### -WebTemplate -A switch that if provided, applies the site design to the default site template. For more information, see [Customize a default site design](https://learn.microsoft.com/sharepoint/dev/declarative-customization/customize-default-site-design). +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: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -205,8 +231,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteGroup.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteGroup.md index 220956713..1ebad3d2c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteGroup.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spositegroup applicable: SharePoint Online @@ -18,20 +18,21 @@ Updates the SharePoint Online owner and permission levels on a group inside a si ## SYNTAX -```powershell -Set-SPOSiteGroup -Identity [-Name ] [-Owner ] [-PermissionLevelsToAdd ] - [-PermissionLevelsToRemove ] -Site [] +``` +Set-SPOSiteGroup -Site -Identity [-Name ] + [-PermissionLevelsToAdd ] [-PermissionLevelsToRemove ] [-Owner ] + [] ``` ## DESCRIPTION You must be at least a SharePoint Online administrator and be a site collection administrator to run the `Set-SPOSiteGroup` cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Set-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -Identity "ProjectViewers" -PermissionLevelsToRemove "Full Control" -PermissionLevelsToAdd "View Only" @@ -39,7 +40,7 @@ Set-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -Identity "Pro Example 1 changes permission level of the ProjectViewers group inside site collection from Full Control to View Only. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Set-SPOSiteGroup -Site https://contoso.sharepoint.com -Identity "ProjectViewers" -Owner Melissa.kerr@contoso.com @@ -54,7 +55,7 @@ Example 2 sets Melissa.kerr@contoso.com as the owner of the ProjectViewers group Specifies the name of the group. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -70,7 +71,7 @@ Accept wildcard characters: False Specifies the new name of the group. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -86,7 +87,7 @@ Accept wildcard characters: False Specifies the owner (individual or a security group) of the group to be created. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -102,10 +103,10 @@ Accept wildcard characters: False Specifies the permission levels to grant to the group. > [!NOTE] -> Permission levels are defined by SharePoint Online administrators from SharePoint Online Administration Center. +> Permission levels are defined by SharePoint Online administrators from SharePoint Online Administration Center. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -121,10 +122,10 @@ Accept wildcard characters: False Specifies the permission levels to remove from the group. > [!NOTE] -> Permission levels are defined by SharePoint Online administrators from SharePoint Online Administration Center. +> Permission levels are defined by SharePoint Online administrators from SharePoint Online Administration Center. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -140,7 +141,7 @@ Accept wildcard characters: False Specifies the site collection the group belongs to. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -163,6 +164,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOSiteGroup](Get-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md index b2399a59d..b4df3f63c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteOffice365Group.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spositeoffice365group applicable: SharePoint Online @@ -18,16 +18,9 @@ Connects a top-level SPO site collection to a new Microsoft 365 Group. ## SYNTAX -```powershell -Set-SPOSiteOffice365Group - -Site - -DisplayName - -Alias - [-IsPublic] - [-Description ] - [-Classification ] - [-KeepOldHomepage] - [] +``` +Set-SPOSiteOffice365Group [-Site] [-DisplayName] [-Alias] [-IsPublic] + [[-Description] ] [[-Classification] ] [-KeepOldHomepage] [] ``` ## DESCRIPTION @@ -56,69 +49,73 @@ Set-SPOSiteOffice365Group -Site https://contoso.sharepoint.com/sites/classicsite ## PARAMETERS -### -Site +### -Alias -The site collection being connected to new Office 365 Group. +Specifies the email alias for the new Microsoft 365 Group that will be created. ```yaml -Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False -Accept wildcard characters: False +Accept wildcard characters: False ``` -### -DisplayName +### -Classification -Specifies the name of the new Microsoft 365 Group that will be created. +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. + +See [Manage Office 365 Groups with PowerShell](https://support.office.com/en-us/article/Manage-Office-365-Groups-with-PowerShell-aeb669aa-1770-4537-9de2-a82ac11b0540) for more information. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: Named +Required: False +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Alias +### -Description -Specifies the email alias for the new Microsoft 365 Group that will be created. +Specifies the group's description. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: Named +Required: False +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -DisplayName -Specifies the group's description. +Specifies the name of the new Microsoft 365 Group that will be created. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -129,52 +126,62 @@ Accept wildcard characters: False Determines the Microsoft 365 Group's privacy setting. If switch is included, the group will be public, otherwise it will be private. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Classification - -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. +### -KeepOldHomepage -See [Manage Office 365 Groups with PowerShell](https://support.office.com/en-us/article/Manage-Office-365-Groups-with-PowerShell-aeb669aa-1770-4537-9de2-a82ac11b0540) for more information. +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: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: Named +Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepOldHomepage +### -Site -For sites that already have a modern page set as homepage, you can specify whether you want to keep it as the homepage. +The site collection being connected to new Office 365 Group. ```yaml -Type: SwitchParameter +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: -Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScript.md similarity index 74% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScript.md index 2c20adb0a..a71acd994 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScript.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spositescript applicable: SharePoint Online @@ -18,14 +18,9 @@ Updates a previously uploaded site script. ## SYNTAX -```powershell -Set-SPOSiteScript - -Identity - -Title - -Content - [-Description ] - [-Version ] - [] +``` +Set-SPOSiteScript -Identity [-Title ] [-Content ] + [-Description ] [-Version ] [] ``` ## DESCRIPTION @@ -71,28 +66,28 @@ Set-SPOSiteScript -Identity edaec4ec-71e2-4026-ac1e-6686bb30190d -Content $newna ## PARAMETERS -### -Identity +### -Content -The id of the site design. +The JSON value that describes the script. For more information, see the [JSON reference](/sharepoint/dev/declarative-customization/site-design-json-schema). ```yaml -Type: SPOSiteDesignPipeBind +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Title +### -Description -The display name of the site design. +A description of the script. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -103,28 +98,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Content +### -Identity -The JSON value that describes the script. For more information, see the [JSON reference](https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema). +The id of the site design. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Title -A description of the script. +The display name of the site design. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -140,7 +135,7 @@ Accept wildcard characters: False A version number of the script. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -151,8 +146,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### System.String + ## OUTPUTS +### System.Object + ## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScriptPackage.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScriptPackage.md similarity index 95% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScriptPackage.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScriptPackage.md index d6957a25b..32f61cb6f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScriptPackage.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSiteScriptPackage.md @@ -55,7 +55,7 @@ This example updates a site script package with ID 'edaec4ec-71e2-4026-ac1e-6686 The absolute path to a zip archive file containing the content of the new site script package. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -70,7 +70,7 @@ Accept wildcard characters: False A description of the site script. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -85,7 +85,7 @@ Accept wildcard characters: False The ID of the site script. ```yaml -Type: SPOSiteScriptPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SPOSiteScriptPipeBind Parameter Sets: (All) Aliases: @@ -100,7 +100,7 @@ Accept wildcard characters: False The display name of the site script. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -115,7 +115,7 @@ Accept wildcard characters: False The version number of the site script. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStorageEntity.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStorageEntity.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStorageEntity.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStorageEntity.md index 2b9cf5053..8134deec6 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStorageEntity.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStorageEntity.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spostorageentity applicable: SharePoint Online @@ -18,8 +18,9 @@ Tenant properties allow tenant administrators to add properties in the app catal ## SYNTAX -```powershell -Set-SPOStorageEntity -Site -Key -Value -Comments -Description [-WhatIf] [-Confirm] [] +``` +Set-SPOStorageEntity -Site -Key -Value -Comments + -Description [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,12 +39,12 @@ This example adds an entry to the property bag. ## PARAMETERS -### -Site +### -Comments -URL to the tenant or site collection app catalog. +Comment for this property bag entry. ```yaml -Type: SpoSitePipeBind +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -54,12 +55,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Key +### -Description -The key in the property bag that should be added or updated. +Description of the property. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -70,12 +71,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Value +### -Key -Value to be set. +The key in the property bag that should be added or updated. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -86,12 +87,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Comments +### -Site -Comment for this property bag entry. +URL to the tenant or site collection app catalog. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -102,12 +103,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Value -Description of the property. +Value to be set. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -124,7 +125,7 @@ Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -136,12 +137,11 @@ Accept wildcard characters: False ``` ### -WhatIf - -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` +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -153,8 +153,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md similarity index 70% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheSiteState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md index 1898a6109..7b16ac501 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheSiteState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheSiteState.md @@ -14,7 +14,7 @@ ms.reviewer: # Set-SPOStructuralNavigationCacheSiteState ## SYNOPSIS -Enable or disable caching for all webs in a site collection. +Enable or disable caching for all webs in a site collection. ## SYNTAX @@ -23,31 +23,31 @@ Set-SPOStructuralNavigationCacheSiteState -SiteUrl -IsEnabled ``` ## DESCRIPTION -The Set-SPOStructuralNavigationCacheSiteState cmdlet can be used to enable or disable caching for all webs in a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). +The Set-SPOStructuralNavigationCacheSiteState cmdlet can be used to enable or disable caching for all webs in a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). ## EXAMPLES ### Example 1 ```powershell -PS C:\> Set-SPOStructuralNavigationCacheSiteState -IsEnabled $true -SiteUrl "https://contoso.sharepoint.com/sites/product/" +PS C:\> Set-SPOStructuralNavigationCacheSiteState -IsEnabled $true -SiteUrl "https://contoso.sharepoint.com/sites/product/" ``` -This example enables caching for all webs in the site collection https://contoso.sharepoint.com/sites/product/. +This example enables caching for all webs in the site collection https://contoso.sharepoint.com/sites/product/. ### Example 2 ```powershell -PS C:\> Set-SPOStructuralNavigationCacheSiteState -IsEnabled $false -SiteUrl "https://contoso.sharepoint.com/sites/product/" +PS C:\> Set-SPOStructuralNavigationCacheSiteState -IsEnabled $false -SiteUrl "https://contoso.sharepoint.com/sites/product/" ``` -This example disables caching for all webs in the site collection https://contoso.sharepoint.com/sites/product/. +This example disables caching for all webs in the site collection https://contoso.sharepoint.com/sites/product/. ## PARAMETERS ### -IsEnabled -$true to enable caching, $false to disable caching. +$true to enable caching, $false to disable caching. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -59,10 +59,10 @@ Accept wildcard characters: False ``` ### -SiteUrl -Specifies the absolute URL for the site collection's root web that needs its caching state to be set. +Specifies the absolute URL for the site collection's root web that needs its caching state to be set. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -74,7 +74,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -83,20 +83,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES - To see the examples, type: "get-help Set-SPOStructuralNavigationCacheSiteState -examples". - For more information, type: "get-help Set-SPOStructuralNavigationCacheSiteState -detailed". +To see the examples, type: "get-help Set-SPOStructuralNavigationCacheSiteState -examples". + +For more information, type: "get-help Set-SPOStructuralNavigationCacheSiteState -detailed". - For technical information, type: "get-help Set-SPOStructuralNavigationCacheSiteState -full". +For technical information, type: "get-help Set-SPOStructuralNavigationCacheSiteState -full". + +For online help, type: "get-help Set-SPOStructuralNavigationCacheSiteState -online" - For online help, type: "get-help Set-SPOStructuralNavigationCacheSiteState -online" - ## RELATED LINKS [Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) [Set-SPOStructuralNavigationCacheWebState](Set-SPOStructuralNavigationCacheWebState.md) [Get-SPOStructuralNavigationCacheSiteState](Get-SPOStructuralNavigationCacheSiteState.md) - + diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheWebState.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheWebState.md similarity index 73% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheWebState.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheWebState.md index 3d78b2663..be2bf7f9d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheWebState.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOStructuralNavigationCacheWebState.md @@ -14,7 +14,7 @@ ms.reviewer: # Set-SPOStructuralNavigationCacheWebState ## SYNOPSIS -Enable or disable caching for a web in a site collection. +Enable or disable caching for a web in a site collection. ## SYNTAX @@ -23,30 +23,30 @@ Set-SPOStructuralNavigationCacheWebState -WebUrl -IsEnabled [ ``` ## DESCRIPTION -The Set-SPOStructuralNavigationCacheWebState cmdlet can be used to enable or disable caching for a web in a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). +The Set-SPOStructuralNavigationCacheWebState cmdlet can be used to enable or disable caching for a web in a site collection. [Learn more](https://support.office.com/article/structural-navigation-and-performance-f163053f-8eca-4b9c-b973-36b395093b43). ## EXAMPLES ### Example 1 ```powershell -PS C:\> Set-SPOStructuralNavigationCacheWebState -IsEnabled $true -WebUrl "https://contoso.sharepoint.com/sites/product/electronics" +PS C:\> Set-SPOStructuralNavigationCacheWebState -IsEnabled $true -WebUrl "https://contoso.sharepoint.com/sites/product/electronics" ``` -This example enables caching for the web https://contoso.sharepoint.com/sites/product/electronics. +This example enables caching for the web https://contoso.sharepoint.com/sites/product/electronics. ### Example 2 ```powershell -Set-SPOStructuralNavigationCacheWebState -IsEnabled $false -WebUrl "https://contoso.sharepoint.com/sites/product/electronics" +Set-SPOStructuralNavigationCacheWebState -IsEnabled $false -WebUrl "https://contoso.sharepoint.com/sites/product/electronics" ``` -This example disables caching for the web https://contoso.sharepoint.com/sites/product/electronics. +This example disables caching for the web https://contoso.sharepoint.com/sites/product/electronics. ## PARAMETERS ### -IsEnabled -$true to enable caching, $false to disable caching. +$true to enable caching, $false to disable caching. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -58,10 +58,10 @@ Accept wildcard characters: False ``` ### -WebUrl -Specifies the absolute URL for the web that needs its caching state to be set. +Specifies the absolute URL for the web that needs its caching state to be set. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -73,7 +73,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -82,15 +82,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES - To see the examples, type: "get-help Set-SPOStructuralNavigationCacheWebState -examples". - For more information, type: "get-help Set-SPOStructuralNavigationCacheWebState -detailed". +To see the examples, type: "get-help Set-SPOStructuralNavigationCacheWebState -examples". + +For more information, type: "get-help Set-SPOStructuralNavigationCacheWebState -detailed". + +For technical information, type: "get-help Set-SPOStructuralNavigationCacheWebState -full". - For technical information, type: "get-help Set-SPOStructuralNavigationCacheWebState -full". +For online help, type: "get-help Set-SPOStructuralNavigationCacheWebState -online" - For online help, type: "get-help Set-SPOStructuralNavigationCacheWebState -online" - ## RELATED LINKS [Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTemporarilyDisableAppBar.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTemporarilyDisableAppBar.md new file mode 100644 index 000000000..f5844579e --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTemporarilyDisableAppBar.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOTemporarilyDisableAppBar + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOTemporarilyDisableAppBar [-Value] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Value +{{ Fill Value Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Boolean + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md similarity index 59% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md index 412a0d133..61aa829b4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenant.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenant applicable: SharePoint Online @@ -18,212 +18,453 @@ Sets properties on the SharePoint Online organization. ## SYNTAX -```powershell -Set-SPOTenant - [-AIBuilderModelScope ] - [-AIBuilderModelSelectedSitesIncludesContentCenters ] - [-AIBuilderModelSelectedSitesList [String[]]] +### None (Default) +``` +Set-SPOTenant [-MinCompatibilityLevel ] [-MaxCompatibilityLevel ] + [-ExternalServicesEnabled ] [-NoAccessRedirectUrl ] [-ArchiveRedirectUrl ] + [-SharingCapability ] [-DisplayStartASiteOption ] [-StartASiteFormUrl ] + [-ShowEveryoneClaim ] [-ShowAllUsersClaim ] + [-ShowEveryoneExceptExternalUsersClaim ] + [-AllowEveryoneExceptExternalUsersClaimInPrivateSite ] [-SearchResolveExactEmailOrUPN ] + [-OfficeClientADALDisabled ] [-LegacyAuthProtocolsEnabled ] + [-LegacyBrowserAuthProtocolsEnabled ] [-DisableCustomAppAuthentication ] + [-IsSharePointAddInsDisabled ] [-IsSharePointAddInsBlocked ] + [-DisableSharePointStoreAccess ] [-SiteOwnerManageLegacyServicePrincipalEnabled ] + [-RequireAcceptingAccountMatchInvitedAccount ] [-ProvisionSharedWithEveryoneFolder ] + [-SignInAccelerationDomain ] [-EnableGuestSignInAcceleration ] + [-UsePersistentCookiesForExplorerView ] [-ReSyncTenantPrivacyProfile] + [-BccExternalSharingInvitations ] [-BccExternalSharingInvitationsList ] + [-PublicCdnEnabled ] [-PublicCdnAllowedFileTypes ] + [-RequireAnonymousLinksExpireInDays ] [-SharingAllowedDomainList ] + [-SharingBlockedDomainList ] [-SharingDomainRestrictionMode ] + [-OneDriveStorageQuota ] [-OneDriveForGuestsEnabled ] [-IPAddressEnforcement ] + [-IPAddressAllowList ] [-IPAddressWACTokenLifetime ] + [-EnableTenantRestrictionsInsights ] [-EnablePromotedFileHandlers ] + [-UseFindPeopleInPeoplePicker ] [-DefaultSharingLinkType ] + [-ODBMembersCanShare ] [-ODBAccessRequests ] + [-PreventExternalUsersFromResharing ] [-ShowPeoplePickerSuggestionsForGuestUsers ] + [-AppOnlyBypassPeoplePickerPolicies ] [-EnableDiscoverableByOrganizationForVideos ] + [-FileAnonymousLinkType ] [-FolderAnonymousLinkType ] + [-NotifyOwnersWhenItemsReshared ] [-NotifyOwnersWhenInvitationsAccepted ] + [-NotificationsInOneDriveForBusinessEnabled ] [-NotificationsInSharePointEnabled ] + [-SelfServiceSiteCreationDisabled ] + [-SpecialCharactersStateInFileFolderNames ] [-OwnerAnonymousNotification ] + [-CommentsOnSitePagesDisabled ] [-CommentsOnFilesDisabled ] + [-CommentsOnListItemsDisabled ] [-ViewersCanCommentOnMediaDisabled ] + [-SocialBarOnSitePagesDisabled ] [-OrphanedPersonalSitesRetentionPeriod ] + [-PermissiveBrowserFileHandlingOverride ] [-DisallowInfectedFileDownload ] + [-DefaultLinkPermission ] [-CustomizedExternalSharingServiceUrl ] + [-ConditionalAccessPolicyErrorHelpLink ] [-RestrictedAccessControlforSitesErrorHelpLink ] + [-RestrictedAccessControlForOneDriveErrorHelpLink ] + [-ApplyAppEnforcedRestrictionsToAdHocRecipients ] [-FilePickerExternalImageSearchEnabled ] + [-EmailAttestationRequired ] [-EmailAttestationReAuthDays ] + [-SyncPrivacyProfileProperties ] [-DisabledWebPartIds ] + [-DisabledAdaptiveCardExtensionIds ] [-EnableMinimumVersionRequirement ] + [-MarkNewFilesSensitiveByDefault ] [-EnableAIPIntegration ] + [-SyncAadB2BManagementPolicy ] [-AllowCommentsTextOnEmailEnabled ] + [-EnableAzureADB2BIntegration ] [-DisableAddShortcutsToOneDrive ] + [-IncludeAtAGlanceInShareEmails ] [-DisableWorkflow2010 ] [-EnableAutoNewsDigest ] + [-StopNew2010Workflows ] [-StopNew2013Workflows ] [-DisableBackToClassic ] + [-ExternalUserExpirationRequired ] [-ExternalUserExpireInDays ] + [-BlockDownloadLinksFileType ] [-AnyoneLinkTrackUsers ] + [-BlockAppAccessWithAuthenticationContext ] [-OneDriveLoopDefaultSharingLinkScope ] + [-OneDriveLoopDefaultSharingLinkRole ] [-OneDriveRequestFilesLinkEnabled ] + [-OneDriveRequestFilesLinkExpirationInDays ] [-OneDriveSharingCapability ] + [-OneDriveDefaultShareLinkScope ] [-OneDriveDefaultShareLinkRole ] + [-OneDriveDefaultLinkToExistingAccess ] [-OneDriveBlockGuestsAsSiteAdmin ] + [-CoreLoopDefaultSharingLinkScope ] [-CoreLoopDefaultSharingLinkRole ] + [-CoreSharingCapability ] [-AllowSharingOutsideRestrictedAccessControlGroups ] + [-CoreRequestFilesLinkEnabled ] [-CoreRequestFilesLinkExpirationInDays ] + [-CoreDefaultShareLinkScope ] [-CoreDefaultShareLinkRole ] + [-CoreDefaultLinkToExistingAccess ] [-CoreBlockGuestsAsSiteAdmin ] + [-AllowAnonymousMeetingParticipantsToAccessWhiteboards ] [-Workflows2013Enabled ] + [-IsFluidEnabled ] [-IsWBFluidEnabled ] [-IsCollabMeetingNotesFluidEnabled ] + [-IsLoopEnabled ] [-DisableDocumentLibraryDefaultLabeling ] + [-ExtendPermissionsToUnprotectedFiles ] [-EnableSensitivityLabelForPDF ] + [-BlockSendLabelMismatchEmail ] [-LabelMismatchEmailHelpLink ] + [-BlockUserInfoVisibility ] [-BlockUserInfoVisibilityInOneDrive ] + [-BlockUserInfoVisibilityInSharePoint ] + [-AllowOverrideForBlockUserInfoVisibility ] [-DisablePersonalListCreation ] + [-DisableSpacesActivation ] [-DisableVivaConnectionsAnalytics ] + [-InformationBarriersSuspension ] [-IBImplicitGroupBased ] + [-AppBypassInformationBarriers ] [-AppAccessInformationBarriersAllowList ] + [-AllOrganizationSecurityGroupId ] [-DisableModernListTemplateIds ] + [-EnableModernListTemplateIds ] [-HideSyncButtonOnTeamSite ] + [-AllowGuestUserShareToUsersNotInSiteCollection ] [-StreamLaunchConfig ] + [-DelegateRestrictedContentDiscoverabilityManagement ] + [-DelegateRestrictedAccessControlManagement ] [-DisableOutlookPSTVersionTrimming ] + [-MediaTranscription ] + [-MediaTranscriptionAutomaticFeatures ] + [-ViewInFileExplorerEnabled ] [-AuthContextResilienceMode ] + [-ReduceTempTokenLifetimeEnabled ] [-ReduceTempTokenLifetimeValue ] + [-ShowOpenInDesktopOptionForSyncedFiles ] [-ShowPeoplePickerGroupSuggestionsForIB ] + [-EnableRestrictedAccessControl ] [-BlockDownloadFileTypePolicy ] + [-BlockDownloadFileTypeIds ] [-ExcludedBlockDownloadGroupIds ] + [-TlsTokenBindingPolicyValue ] [-RecycleBinRetentionPeriod ] + [-IsEnableAppAuthPopUpEnabled ] [-IsDataAccessInCardDesignerEnabled ] + [-MassDeleteNotificationDisabled ] [-EnableAutoExpirationVersionTrim ] + [-EnableMediaReactions ] [-BusinessConnectivityServiceDisabled ] + [-ExpireVersionsAfterDays ] [-MajorVersionLimit ] [-AllowSensitivityLabelOnRecords ] + [-DelayDenyAddAndCustomizePagesEnforcement ] + [-DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites ] + [-AllowClassicPublishingSiteCreation ] [-WhoCanShareAnonymousAllowList ] + [-WhoCanShareAuthenticatedGuestAllowList ] + [-ResyncContentSecurityPolicyConfigurationEntries ] [-ContentSecurityPolicyEnforcement ] + [-DocumentUnderstandingModelScope ] + [-DocumentUnderstandingModelSelectedSitesList ] + [-DocumentUnderstandingModelSelectedSitesListOperation ] + [-AIBuilderModelScope ] [-AIBuilderModelSelectedSitesList ] [-AIBuilderModelSelectedSitesListOperation ] - [-AllOrganizationSecurityGroupId ] - [-AllowAnonymousMeetingParticipantsToAccessWhiteboards ] - [-AllowClassicPublishingSiteCreation ] - [-AllowCommentsTextOnEmailEnabled ] - [-AllowDownloadingNonWebViewableFiles ] - [-AllowEditing ] - [-AllowEveryoneExceptExternalUsersClaimInPrivateSite ] - [-AllowGuestUserShareToUsersNotInSiteCollection ] - [-AllowOverrideForBlockUserInfoVisibility] - [-AllowSensitivityLabelOnRecords ] - [-AllowSelectSecurityGroupsInSPSitesList [String[]]] - [-AllowSelectSGsInODBListInTenant [String[]]] - [-AllowSharingOutsideRestrictedAccessControlGroups ] - [-AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled ] - [-AnyoneLinkTrackUsers ] - [-AppAccessInformationBarriersAllowList [String[]]] - [-AppBypassInformationBarriers ] - [-ApplyAppEnforcedRestrictionsToAdHocRecipients ] - [-AutofillColumnScope ] - [-AutofillColumnsSelectedSitesList [String[]]] + [-AIBuilderModelSelectedSitesIncludesContentCenters ] [-PrebuiltModelScope ] + [-PrebuiltModelSelectedSitesList ] + [-PrebuiltModelSelectedSitesListOperation ] + [-DocumentTranslationScope ] [-DocumentTranslationSelectedSitesList ] + [-DocumentTranslationSelectedSitesListOperation ] + [-AutofillColumnsScope ] [-AutofillColumnsSelectedSitesList ] [-AutofillColumnsSelectedSitesListOperation ] - [-BccExternalSharingInvitations ] - [-BccExternalSharingInvitationsList ] - [-BlockDownloadFileTypeIds [SPBlockDownloadFileTypeId[]]] - [-BlockDownloadFileTypePolicy ] - [-BlockDownloadLinksFileType ] - [-BlockSendLabelMismatchEmail ] - [-BlockUserInfoVisibility ] - [-BlockUserInfoVisibilityInOneDrive ] - [-BlockUserInfoVisibilityInSharePoint ] - [-BusinessConnectivityServiceDisabled ] - [-CommentsOnFilesDisabled ] - [-CommentsOnListItemsDisabled ] - [-CommentsOnSitePagesDisabled ] - [-ConditionalAccessPolicy ] - [-ConditionalAccessPolicyErrorHelpLink ] - [-ContentSecurityPolicyEnforcement ] - [-ContentTypeSyncSiteTemplatesList [String[]]] - [-CoreDefaultLinkToExistingAccess ] - [-CoreDefaultShareLinkRole ] - [-CoreDefaultShareLinkScope ] - [-CoreLoopDefaultSharingLinkRole ] - [-CoreLoopDefaultSharingLinkScope ] - [-CoreRequestFilesLinkEnabled ] - [-CoreRequestFilesLinkExpirationInDays ] - [-CoreSharingCapability ] - [-CustomizedExternalSharingServiceUrl ] + [-OpticalCharacterRecognitionScope ] + [-OpticalCharacterRecognitionSelectedSitesList ] + [-OpticalCharacterRecognitionSelectedSitesListOperation ] [-DefaultContentCenterSite ] - [-DefaultLinkPermission ] - [-DefaultOneDriveInformationBarrierMode ] - [-DefaultSharingLinkType ] - [-DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites ] - [-DelegateRestrictedAccessControlManagement ] + [-AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled ] [-EnforceRequestDigest ] + [] +``` + +### ParameterSetContentTypeSyncSiteTemplatesList +``` +Set-SPOTenant [-MinCompatibilityLevel ] [-MaxCompatibilityLevel ] + [-ExternalServicesEnabled ] [-NoAccessRedirectUrl ] [-ArchiveRedirectUrl ] + [-SharingCapability ] [-DisplayStartASiteOption ] [-StartASiteFormUrl ] + [-ShowEveryoneClaim ] [-ShowAllUsersClaim ] + [-ShowEveryoneExceptExternalUsersClaim ] + [-AllowEveryoneExceptExternalUsersClaimInPrivateSite ] [-SearchResolveExactEmailOrUPN ] + [-OfficeClientADALDisabled ] [-LegacyAuthProtocolsEnabled ] + [-LegacyBrowserAuthProtocolsEnabled ] [-DisableCustomAppAuthentication ] + [-IsSharePointAddInsDisabled ] [-IsSharePointAddInsBlocked ] + [-DisableSharePointStoreAccess ] [-SiteOwnerManageLegacyServicePrincipalEnabled ] + [-RequireAcceptingAccountMatchInvitedAccount ] [-ProvisionSharedWithEveryoneFolder ] + [-SignInAccelerationDomain ] [-EnableGuestSignInAcceleration ] + [-UsePersistentCookiesForExplorerView ] -ContentTypeSyncSiteTemplatesList + [-ExcludeSiteTemplate] [-ReSyncTenantPrivacyProfile] [-BccExternalSharingInvitations ] + [-BccExternalSharingInvitationsList ] [-PublicCdnEnabled ] + [-PublicCdnAllowedFileTypes ] [-RequireAnonymousLinksExpireInDays ] + [-SharingAllowedDomainList ] [-SharingBlockedDomainList ] + [-SharingDomainRestrictionMode ] [-OneDriveStorageQuota ] + [-OneDriveForGuestsEnabled ] [-IPAddressEnforcement ] [-IPAddressAllowList ] + [-IPAddressWACTokenLifetime ] [-EnableTenantRestrictionsInsights ] + [-EnablePromotedFileHandlers ] [-UseFindPeopleInPeoplePicker ] + [-DefaultSharingLinkType ] [-ODBMembersCanShare ] + [-ODBAccessRequests ] [-PreventExternalUsersFromResharing ] + [-ShowPeoplePickerSuggestionsForGuestUsers ] [-AppOnlyBypassPeoplePickerPolicies ] + [-EnableDiscoverableByOrganizationForVideos ] [-FileAnonymousLinkType ] + [-FolderAnonymousLinkType ] [-NotifyOwnersWhenItemsReshared ] + [-NotifyOwnersWhenInvitationsAccepted ] [-NotificationsInOneDriveForBusinessEnabled ] + [-NotificationsInSharePointEnabled ] [-SelfServiceSiteCreationDisabled ] + [-SpecialCharactersStateInFileFolderNames ] [-OwnerAnonymousNotification ] + [-CommentsOnSitePagesDisabled ] [-CommentsOnFilesDisabled ] + [-CommentsOnListItemsDisabled ] [-ViewersCanCommentOnMediaDisabled ] + [-SocialBarOnSitePagesDisabled ] [-OrphanedPersonalSitesRetentionPeriod ] + [-PermissiveBrowserFileHandlingOverride ] [-DisallowInfectedFileDownload ] + [-DefaultLinkPermission ] [-CustomizedExternalSharingServiceUrl ] + [-ConditionalAccessPolicyErrorHelpLink ] [-RestrictedAccessControlforSitesErrorHelpLink ] + [-RestrictedAccessControlForOneDriveErrorHelpLink ] + [-ApplyAppEnforcedRestrictionsToAdHocRecipients ] [-FilePickerExternalImageSearchEnabled ] + [-EmailAttestationRequired ] [-EmailAttestationReAuthDays ] + [-SyncPrivacyProfileProperties ] [-DisabledWebPartIds ] + [-DisabledAdaptiveCardExtensionIds ] [-EnableMinimumVersionRequirement ] + [-MarkNewFilesSensitiveByDefault ] [-EnableAIPIntegration ] + [-SyncAadB2BManagementPolicy ] [-AllowCommentsTextOnEmailEnabled ] + [-EnableAzureADB2BIntegration ] [-DisableAddShortcutsToOneDrive ] + [-IncludeAtAGlanceInShareEmails ] [-DisableWorkflow2010 ] [-EnableAutoNewsDigest ] + [-StopNew2010Workflows ] [-StopNew2013Workflows ] [-DisableBackToClassic ] + [-ExternalUserExpirationRequired ] [-ExternalUserExpireInDays ] + [-BlockDownloadLinksFileType ] [-AnyoneLinkTrackUsers ] + [-BlockAppAccessWithAuthenticationContext ] [-OneDriveLoopDefaultSharingLinkScope ] + [-OneDriveLoopDefaultSharingLinkRole ] [-OneDriveRequestFilesLinkEnabled ] + [-OneDriveRequestFilesLinkExpirationInDays ] [-OneDriveSharingCapability ] + [-OneDriveDefaultShareLinkScope ] [-OneDriveDefaultShareLinkRole ] + [-OneDriveDefaultLinkToExistingAccess ] [-OneDriveBlockGuestsAsSiteAdmin ] + [-CoreLoopDefaultSharingLinkScope ] [-CoreLoopDefaultSharingLinkRole ] + [-CoreSharingCapability ] [-AllowSharingOutsideRestrictedAccessControlGroups ] + [-CoreRequestFilesLinkEnabled ] [-CoreRequestFilesLinkExpirationInDays ] + [-CoreDefaultShareLinkScope ] [-CoreDefaultShareLinkRole ] + [-CoreDefaultLinkToExistingAccess ] [-CoreBlockGuestsAsSiteAdmin ] + [-AllowAnonymousMeetingParticipantsToAccessWhiteboards ] [-Workflows2013Enabled ] + [-IsFluidEnabled ] [-IsWBFluidEnabled ] [-IsCollabMeetingNotesFluidEnabled ] + [-IsLoopEnabled ] [-DisableDocumentLibraryDefaultLabeling ] + [-ExtendPermissionsToUnprotectedFiles ] [-EnableSensitivityLabelForPDF ] + [-BlockSendLabelMismatchEmail ] [-LabelMismatchEmailHelpLink ] + [-BlockUserInfoVisibility ] [-BlockUserInfoVisibilityInOneDrive ] + [-BlockUserInfoVisibilityInSharePoint ] + [-AllowOverrideForBlockUserInfoVisibility ] [-DisablePersonalListCreation ] + [-DisableSpacesActivation ] [-DisableVivaConnectionsAnalytics ] + [-InformationBarriersSuspension ] [-IBImplicitGroupBased ] + [-AppBypassInformationBarriers ] [-AppAccessInformationBarriersAllowList ] + [-AllOrganizationSecurityGroupId ] [-DisableModernListTemplateIds ] + [-EnableModernListTemplateIds ] [-HideSyncButtonOnTeamSite ] + [-AllowGuestUserShareToUsersNotInSiteCollection ] [-StreamLaunchConfig ] [-DelegateRestrictedContentDiscoverabilityManagement ] - [-DenySelectSecurityGroupsInSPSitesList [String[]]] - [-DenySelectSGsInODBListInTenant [String[]]] - [-DisableAddShortcutsToOneDrive ] - [-DisableBackToClassic ] - [-DisableCustomAppAuthentication ] - [-DisabledAdaptiveCardExtensionIds [Guid[]]] - [-DisableDocumentLibraryDefaultLabeling ] - [-DisabledWebPartIds [Guid[]]] - [-DisableModernListTemplateIds [Guid[]]] - [-DisableOutlookPSTVersionTrimming ] - [-DisablePersonalListCreation ] - [-DisableSharePointStoreAccess ] - [-DisableSpacesActivation ] - [-DisableVivaConnectionsAnalytics ] - [-DisableWorkflow2010 ] - [-DisallowInfectedFileDownload ] - [-DisplayStartASiteOption ] - [-DocumentTranslationScope ] - [-DocumentTranslationSelectedSitesList [String[]]] - [-DocumentTranslationSelectedSitesListOperation ] + [-DelegateRestrictedAccessControlManagement ] [-DisableOutlookPSTVersionTrimming ] + [-MediaTranscription ] + [-MediaTranscriptionAutomaticFeatures ] + [-ViewInFileExplorerEnabled ] [-AuthContextResilienceMode ] + [-ReduceTempTokenLifetimeEnabled ] [-ReduceTempTokenLifetimeValue ] + [-ShowOpenInDesktopOptionForSyncedFiles ] [-ShowPeoplePickerGroupSuggestionsForIB ] + [-EnableRestrictedAccessControl ] [-BlockDownloadFileTypePolicy ] + [-BlockDownloadFileTypeIds ] [-ExcludedBlockDownloadGroupIds ] + [-TlsTokenBindingPolicyValue ] [-RecycleBinRetentionPeriod ] + [-IsEnableAppAuthPopUpEnabled ] [-IsDataAccessInCardDesignerEnabled ] + [-MassDeleteNotificationDisabled ] [-EnableAutoExpirationVersionTrim ] + [-EnableMediaReactions ] [-BusinessConnectivityServiceDisabled ] + [-ExpireVersionsAfterDays ] [-MajorVersionLimit ] [-AllowSensitivityLabelOnRecords ] + [-DelayDenyAddAndCustomizePagesEnforcement ] + [-DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites ] + [-AllowClassicPublishingSiteCreation ] [-WhoCanShareAnonymousAllowList ] + [-WhoCanShareAuthenticatedGuestAllowList ] + [-ResyncContentSecurityPolicyConfigurationEntries ] [-ContentSecurityPolicyEnforcement ] [-DocumentUnderstandingModelScope ] - [-DocumentUnderstandingModelSelectedSitesList [String[]]] + [-DocumentUnderstandingModelSelectedSitesList ] [-DocumentUnderstandingModelSelectedSitesListOperation ] - [-EmailAttestationReAuthDays ] - [-EmailAttestationRequired ] - [-EnableAIPIntegration ] - [-EnableAutoExpirationVersionTrim ] - [-EnableAutoNewsDigest ] - [-EnableAzureADB2BIntegration ] - [-EnableDiscoverableByOrganizationForVideos ] - [-EnableGuestSignInAcceleration ] - [-EnableMediaReactions ] - [-EnableMinimumVersionRequirement ] - [-EnableModernListTemplateIds [Guid[]]] - [-EnablePromotedFileHandlers ] - [-EnableRestrictedAccessControl ] - [-EnableSensitivityLabelforPDF ] - [-EnableVersionExpirationSetting ] - [-EnforceContentSecurityPolicy ] - [-EnforceRequestDigest ] - [-ExcludedBlockDownloadGroupIds [Guid[]]] - [-ExcludeSiteTemplate ] - [-ExemptNativeUsersFromTenantLevelRestricedAccessControl ] - [-ExpireVersionsAfterDays ] - [-ExtendPermissionsToUnprotectedFiles ] - [-ExternalServicesEnabled ] - [-ExternalUserExpirationRequired ] - [-ExternalUserExpireInDays ] - [-FileAnonymousLinkType ] - [-FilePickerExternalImageSearchEnabled ] - [-FolderAnonymousLinkType ] - [-HideSyncButtonOnTeamSite ] - [-IBImplicitGroupBased ] - [-IncludeAtAGlanceInShareEmails ] - [-InformationBarriersSuspension ] - [-IPAddressAllowList ] - [-IPAddressEnforcement ] - [-IPAddressWACTokenLifetime ] - [-IsCollabMeetingNotesFluidEnabled ] - [-IsDataAccessInCardDesignerEnabled ] - [-IsEnableAppAuthPopUpEnabled ] - [-IsLoopEnabled ] - [-IsSharePointAddInsDisabled ] - [-IsSharePointAddInsBlocked ] - [-IsWBFluidEnabled ] - [-LabelMismatchEmailHelpLink ] - [-LegacyAuthProtocolsEnabled ] - [-LegacyBrowserAuthProtocolsEnabled ] - [-LimitedAccessFileType ] - [-MajorVersionLimit ] - [-MarkNewFilesSensitiveByDefault ] - [-MassDeleteNotificationDisabled ] - [-MaxCompatibilityLevel ] + [-AIBuilderModelScope ] [-AIBuilderModelSelectedSitesList ] + [-AIBuilderModelSelectedSitesListOperation ] + [-AIBuilderModelSelectedSitesIncludesContentCenters ] [-PrebuiltModelScope ] + [-PrebuiltModelSelectedSitesList ] + [-PrebuiltModelSelectedSitesListOperation ] + [-DocumentTranslationScope ] [-DocumentTranslationSelectedSitesList ] + [-DocumentTranslationSelectedSitesListOperation ] + [-AutofillColumnsScope ] [-AutofillColumnsSelectedSitesList ] + [-AutofillColumnsSelectedSitesListOperation ] + [-OpticalCharacterRecognitionScope ] + [-OpticalCharacterRecognitionSelectedSitesList ] + [-OpticalCharacterRecognitionSelectedSitesListOperation ] + [-DefaultContentCenterSite ] + [-AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled ] [-EnforceRequestDigest ] + [] +``` + +### ParamSetMultipleSites +``` +Set-SPOTenant [-MinCompatibilityLevel ] [-MaxCompatibilityLevel ] + [-ExternalServicesEnabled ] [-NoAccessRedirectUrl ] [-ArchiveRedirectUrl ] + [-SharingCapability ] [-DisplayStartASiteOption ] [-StartASiteFormUrl ] + [-ShowEveryoneClaim ] [-ShowAllUsersClaim ] + [-ShowEveryoneExceptExternalUsersClaim ] + [-AllowEveryoneExceptExternalUsersClaimInPrivateSite ] [-SearchResolveExactEmailOrUPN ] + [-OfficeClientADALDisabled ] [-LegacyAuthProtocolsEnabled ] + [-LegacyBrowserAuthProtocolsEnabled ] [-DisableCustomAppAuthentication ] + [-IsSharePointAddInsDisabled ] [-IsSharePointAddInsBlocked ] + [-DisableSharePointStoreAccess ] [-SiteOwnerManageLegacyServicePrincipalEnabled ] + [-RequireAcceptingAccountMatchInvitedAccount ] [-ProvisionSharedWithEveryoneFolder ] + [-SignInAccelerationDomain ] [-EnableGuestSignInAcceleration ] + [-UsePersistentCookiesForExplorerView ] [-ReSyncTenantPrivacyProfile] + [-BccExternalSharingInvitations ] [-BccExternalSharingInvitationsList ] + [-PublicCdnEnabled ] [-PublicCdnAllowedFileTypes ] + [-RequireAnonymousLinksExpireInDays ] [-SharingAllowedDomainList ] + [-SharingBlockedDomainList ] [-SharingDomainRestrictionMode ] + [-OneDriveStorageQuota ] [-OneDriveForGuestsEnabled ] [-IPAddressEnforcement ] + [-IPAddressAllowList ] [-IPAddressWACTokenLifetime ] + [-EnableTenantRestrictionsInsights ] [-EnablePromotedFileHandlers ] + [-UseFindPeopleInPeoplePicker ] [-DefaultSharingLinkType ] + [-ODBMembersCanShare ] [-ODBAccessRequests ] + [-PreventExternalUsersFromResharing ] [-ShowPeoplePickerSuggestionsForGuestUsers ] + [-AppOnlyBypassPeoplePickerPolicies ] [-EnableDiscoverableByOrganizationForVideos ] + [-FileAnonymousLinkType ] [-FolderAnonymousLinkType ] + [-NotifyOwnersWhenItemsReshared ] [-NotifyOwnersWhenInvitationsAccepted ] + [-NotificationsInOneDriveForBusinessEnabled ] [-NotificationsInSharePointEnabled ] + [-SelfServiceSiteCreationDisabled ] + [-SpecialCharactersStateInFileFolderNames ] [-OwnerAnonymousNotification ] + [-CommentsOnSitePagesDisabled ] [-CommentsOnFilesDisabled ] + [-CommentsOnListItemsDisabled ] [-ViewersCanCommentOnMediaDisabled ] + [-SocialBarOnSitePagesDisabled ] [-OrphanedPersonalSitesRetentionPeriod ] + [-PermissiveBrowserFileHandlingOverride ] [-DisallowInfectedFileDownload ] + [-DefaultLinkPermission ] [-CustomizedExternalSharingServiceUrl ] + [-ConditionalAccessPolicyErrorHelpLink ] [-RestrictedAccessControlforSitesErrorHelpLink ] + [-SensitivityLabel ] [-RestrictedAccessControlForOneDriveErrorHelpLink ] + [-ConditionalAccessPolicy ] [-AllowDownloadingNonWebViewableFiles ] + [-LimitedAccessFileType ] [-AllowEditing ] + [-ApplyAppEnforcedRestrictionsToAdHocRecipients ] [-FilePickerExternalImageSearchEnabled ] + [-EmailAttestationRequired ] [-EmailAttestationReAuthDays ] + [-SyncPrivacyProfileProperties ] [-DisabledWebPartIds ] + [-DisabledAdaptiveCardExtensionIds ] [-EnableMinimumVersionRequirement ] + [-MarkNewFilesSensitiveByDefault ] [-EnableAIPIntegration ] + [-SyncAadB2BManagementPolicy ] [-AllowCommentsTextOnEmailEnabled ] + [-EnableAzureADB2BIntegration ] [-DisableAddShortcutsToOneDrive ] + [-IncludeAtAGlanceInShareEmails ] [-DisableWorkflow2010 ] [-EnableAutoNewsDigest ] + [-StopNew2010Workflows ] [-StopNew2013Workflows ] [-DisableBackToClassic ] + [-Sites ] [-ExternalUserExpirationRequired ] [-ExternalUserExpireInDays ] + [-BlockDownloadLinksFileType ] [-AnyoneLinkTrackUsers ] + [-BlockAppAccessWithAuthenticationContext ] [-OneDriveLoopDefaultSharingLinkScope ] + [-OneDriveLoopDefaultSharingLinkRole ] [-OneDriveRequestFilesLinkEnabled ] + [-OneDriveRequestFilesLinkExpirationInDays ] [-OneDriveSharingCapability ] + [-OneDriveDefaultShareLinkScope ] [-OneDriveDefaultShareLinkRole ] + [-OneDriveDefaultLinkToExistingAccess ] [-OneDriveBlockGuestsAsSiteAdmin ] + [-CoreLoopDefaultSharingLinkScope ] [-CoreLoopDefaultSharingLinkRole ] + [-CoreSharingCapability ] [-AllowSharingOutsideRestrictedAccessControlGroups ] + [-CoreRequestFilesLinkEnabled ] [-CoreRequestFilesLinkExpirationInDays ] + [-CoreDefaultShareLinkScope ] [-CoreDefaultShareLinkRole ] + [-CoreDefaultLinkToExistingAccess ] [-CoreBlockGuestsAsSiteAdmin ] + [-AllowAnonymousMeetingParticipantsToAccessWhiteboards ] [-Workflows2013Enabled ] + [-IsFluidEnabled ] [-IsWBFluidEnabled ] [-IsCollabMeetingNotesFluidEnabled ] + [-IsLoopEnabled ] [-DisableDocumentLibraryDefaultLabeling ] + [-ExtendPermissionsToUnprotectedFiles ] [-EnableSensitivityLabelForPDF ] + [-BlockSendLabelMismatchEmail ] [-LabelMismatchEmailHelpLink ] + [-BlockUserInfoVisibility ] [-BlockUserInfoVisibilityInOneDrive ] + [-BlockUserInfoVisibilityInSharePoint ] + [-AllowOverrideForBlockUserInfoVisibility ] [-DisablePersonalListCreation ] + [-DisableSpacesActivation ] [-DisableVivaConnectionsAnalytics ] + [-InformationBarriersSuspension ] [-IBImplicitGroupBased ] + [-AppBypassInformationBarriers ] [-AppAccessInformationBarriersAllowList ] + [-AllOrganizationSecurityGroupId ] [-DisableModernListTemplateIds ] + [-EnableModernListTemplateIds ] [-HideSyncButtonOnTeamSite ] + [-AllowGuestUserShareToUsersNotInSiteCollection ] [-StreamLaunchConfig ] + [-DelegateRestrictedContentDiscoverabilityManagement ] + [-DelegateRestrictedAccessControlManagement ] [-DisableOutlookPSTVersionTrimming ] [-MediaTranscription ] [-MediaTranscriptionAutomaticFeatures ] - [-MinCompatibilityLevel ] - [-NoAccessRedirectUrl ] - [-NotificationsInOneDriveForBusinessEnabled ] - [-NotificationsInSharePointEnabled ] - [-NotifyOwnersWhenInvitationsAccepted ] - [-NotifyOwnersWhenItemsReshared ] - [-ODBAccessRequests ] - [-ODBMembersCanShare ] - [-OfficeClientADALDisabled ] - [-OneDriveBlockGuestsAsSiteAdmin ] - [-OneDriveDefaultLinkToExistingAccess ] - [-OneDriveDefaultShareLinkRole ] - [-OneDriveDefaultShareLinkScope ] - [-OneDriveForGuestsEnabled ] - [-OneDriveLoopDefaultSharingLinkRole ] - [-OneDriveLoopDefaultSharingLinkScope ] - [-OneDriveRequestFilesLinkEnabled ] - [-OneDriveRequestFilesLinkExpirationInDays ] - [-OneDriveSharingCapability ] - [-OneDriveStorageQuota ] + [-ViewInFileExplorerEnabled ] [-AuthContextResilienceMode ] + [-ReduceTempTokenLifetimeEnabled ] [-ReduceTempTokenLifetimeValue ] + [-ShowOpenInDesktopOptionForSyncedFiles ] [-ShowPeoplePickerGroupSuggestionsForIB ] + [-EnableRestrictedAccessControl ] [-BlockDownloadFileTypePolicy ] + [-BlockDownloadFileTypeIds ] [-ExcludedBlockDownloadGroupIds ] + [-TlsTokenBindingPolicyValue ] [-RecycleBinRetentionPeriod ] + [-IsEnableAppAuthPopUpEnabled ] [-IsDataAccessInCardDesignerEnabled ] + [-MassDeleteNotificationDisabled ] [-EnableAutoExpirationVersionTrim ] + [-EnableMediaReactions ] [-BusinessConnectivityServiceDisabled ] + [-ExpireVersionsAfterDays ] [-MajorVersionLimit ] [-AllowSensitivityLabelOnRecords ] + [-DelayDenyAddAndCustomizePagesEnforcement ] + [-DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites ] + [-AllowClassicPublishingSiteCreation ] [-WhoCanShareAnonymousAllowList ] + [-WhoCanShareAuthenticatedGuestAllowList ] + [-ResyncContentSecurityPolicyConfigurationEntries ] [-ContentSecurityPolicyEnforcement ] + [-DocumentUnderstandingModelScope ] + [-DocumentUnderstandingModelSelectedSitesList ] + [-DocumentUnderstandingModelSelectedSitesListOperation ] + [-AIBuilderModelScope ] [-AIBuilderModelSelectedSitesList ] + [-AIBuilderModelSelectedSitesListOperation ] + [-AIBuilderModelSelectedSitesIncludesContentCenters ] [-PrebuiltModelScope ] + [-PrebuiltModelSelectedSitesList ] + [-PrebuiltModelSelectedSitesListOperation ] + [-DocumentTranslationScope ] [-DocumentTranslationSelectedSitesList ] + [-DocumentTranslationSelectedSitesListOperation ] + [-AutofillColumnsScope ] [-AutofillColumnsSelectedSitesList ] + [-AutofillColumnsSelectedSitesListOperation ] [-OpticalCharacterRecognitionScope ] - [-OpticalCharacterRecognitionSelectedSitesList [String[]]] + [-OpticalCharacterRecognitionSelectedSitesList ] [-OpticalCharacterRecognitionSelectedSitesListOperation ] - [-OrphanedPersonalSitesRetentionPeriod ] - [-OwnerAnonymousNotification ] - [-PermissiveBrowserFileHandlingOverride ] - [-PrebuiltModelScope ] - [-PrebuiltModelSelectedSitesList [String[]]] - [-PrebuiltModelSelectedSitesListOperation ] - [-PreventExternalUsersFromResharing ] - [-ProvisionSharedWithEveryoneFolder ] - [-PublicCdnAllowedFileTypes ] - [-PublicCdnEnabled ] - [-RecycleBinRetentionPeriod ] - [-ReduceTempTokenLifetimeEnabled ] - [-ReduceTempTokenLifetimeValue ] - [-RequireAcceptingAccountMatchInvitedAccount ] - [-RequireAnonymousLinksExpireInDays ] - [-RequireOrganizationLinksExpireInDays ] - [-RestrictedAccessControlforSitesErrorHelpLink ] - [-ResyncContentSecurityPolicyConfigurationEntries ] - [-ReSyncTenantPrivacyProfile ] - [-SearchResolveExactEmailOrUPN ] - [-SelfServiceSiteCreationDisabled ] - [-SensitivityLabel ] - [-SharingAllowedDomainList ] - [-SharingBlockedDomainList ] - [-SharingCapability ] - [-SharingDomainRestrictionMode ] - [-ShowAllUsersClaim ] - [-ShowEveryoneClaim ] + [-DefaultContentCenterSite ] + [-AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled ] [-EnforceRequestDigest ] + [] +``` + +### InformationBarrier +``` +Set-SPOTenant [-MinCompatibilityLevel ] [-MaxCompatibilityLevel ] + [-ExternalServicesEnabled ] [-NoAccessRedirectUrl ] [-ArchiveRedirectUrl ] + [-SharingCapability ] [-DisplayStartASiteOption ] [-StartASiteFormUrl ] + [-ShowEveryoneClaim ] [-ShowAllUsersClaim ] [-ShowEveryoneExceptExternalUsersClaim ] - [-ShowPeoplePickerGroupSuggestionsForIB ] - [-ShowPeoplePickerSuggestionsForGuestUsers ] - [-SignInAccelerationDomain ] - [-SiteOwnerManageLegacyServicePrincipalEnabled ] - [-Sites ] - [-SocialBarOnSitePagesDisabled ] - [-SpecialCharactersStateInFileFolderNames ] - [-StartASiteFormUrl ] - [-StopNew2010Workflows ] - [-StopNew2013Workflows ] - [-StreamLaunchConfig ] - [-SyncAadB2BManagementPolicy ] - [-UseFindPeopleInPeoplePicker ] - [-UsePersistentCookiesForExplorerView ] - [-ViewersCanCommentOnMediaDisabled ] - [-ViewInFileExplorerEnabled ] - [-WhoCanShareAnonymousAllowList [Guid[]]] - [-WhoCanShareAuthenticatedGuestAllowList [Guid[]]] - [-Workflows2013Enabled ] + [-AllowEveryoneExceptExternalUsersClaimInPrivateSite ] [-SearchResolveExactEmailOrUPN ] + [-OfficeClientADALDisabled ] [-LegacyAuthProtocolsEnabled ] + [-LegacyBrowserAuthProtocolsEnabled ] [-DisableCustomAppAuthentication ] + [-IsSharePointAddInsDisabled ] [-IsSharePointAddInsBlocked ] + [-DisableSharePointStoreAccess ] [-SiteOwnerManageLegacyServicePrincipalEnabled ] + [-RequireAcceptingAccountMatchInvitedAccount ] [-ProvisionSharedWithEveryoneFolder ] + [-SignInAccelerationDomain ] [-EnableGuestSignInAcceleration ] + [-UsePersistentCookiesForExplorerView ] [-ReSyncTenantPrivacyProfile] + [-BccExternalSharingInvitations ] [-BccExternalSharingInvitationsList ] + [-PublicCdnEnabled ] [-PublicCdnAllowedFileTypes ] + [-RequireAnonymousLinksExpireInDays ] [-SharingAllowedDomainList ] + [-SharingBlockedDomainList ] [-SharingDomainRestrictionMode ] + [-OneDriveStorageQuota ] [-OneDriveForGuestsEnabled ] [-IPAddressEnforcement ] + [-IPAddressAllowList ] [-IPAddressWACTokenLifetime ] + [-EnableTenantRestrictionsInsights ] [-EnablePromotedFileHandlers ] + [-UseFindPeopleInPeoplePicker ] [-DefaultSharingLinkType ] + [-ODBMembersCanShare ] [-ODBAccessRequests ] + [-PreventExternalUsersFromResharing ] [-ShowPeoplePickerSuggestionsForGuestUsers ] + [-AppOnlyBypassPeoplePickerPolicies ] [-EnableDiscoverableByOrganizationForVideos ] + [-FileAnonymousLinkType ] [-FolderAnonymousLinkType ] + [-NotifyOwnersWhenItemsReshared ] [-NotifyOwnersWhenInvitationsAccepted ] + [-NotificationsInOneDriveForBusinessEnabled ] [-NotificationsInSharePointEnabled ] + [-SelfServiceSiteCreationDisabled ] + [-SpecialCharactersStateInFileFolderNames ] [-OwnerAnonymousNotification ] + [-CommentsOnSitePagesDisabled ] [-CommentsOnFilesDisabled ] + [-CommentsOnListItemsDisabled ] [-ViewersCanCommentOnMediaDisabled ] + [-SocialBarOnSitePagesDisabled ] [-OrphanedPersonalSitesRetentionPeriod ] + [-PermissiveBrowserFileHandlingOverride ] [-DisallowInfectedFileDownload ] + [-DefaultLinkPermission ] [-CustomizedExternalSharingServiceUrl ] + [-ConditionalAccessPolicyErrorHelpLink ] [-RestrictedAccessControlforSitesErrorHelpLink ] + [-RestrictedAccessControlForOneDriveErrorHelpLink ] + [-ApplyAppEnforcedRestrictionsToAdHocRecipients ] [-FilePickerExternalImageSearchEnabled ] + [-EmailAttestationRequired ] [-EmailAttestationReAuthDays ] + [-SyncPrivacyProfileProperties ] [-DisabledWebPartIds ] + [-DisabledAdaptiveCardExtensionIds ] [-EnableMinimumVersionRequirement ] + [-MarkNewFilesSensitiveByDefault ] [-EnableAIPIntegration ] + [-SyncAadB2BManagementPolicy ] [-AllowCommentsTextOnEmailEnabled ] + [-EnableAzureADB2BIntegration ] [-DisableAddShortcutsToOneDrive ] + [-IncludeAtAGlanceInShareEmails ] [-DisableWorkflow2010 ] [-EnableAutoNewsDigest ] + [-StopNew2010Workflows ] [-StopNew2013Workflows ] [-DisableBackToClassic ] + [-ExternalUserExpirationRequired ] [-ExternalUserExpireInDays ] + [-BlockDownloadLinksFileType ] [-AnyoneLinkTrackUsers ] + [-BlockAppAccessWithAuthenticationContext ] [-OneDriveLoopDefaultSharingLinkScope ] + [-OneDriveLoopDefaultSharingLinkRole ] [-OneDriveRequestFilesLinkEnabled ] + [-OneDriveRequestFilesLinkExpirationInDays ] [-OneDriveSharingCapability ] + [-OneDriveDefaultShareLinkScope ] [-OneDriveDefaultShareLinkRole ] + [-OneDriveDefaultLinkToExistingAccess ] [-OneDriveBlockGuestsAsSiteAdmin ] + [-CoreLoopDefaultSharingLinkScope ] [-CoreLoopDefaultSharingLinkRole ] + [-CoreSharingCapability ] [-AllowSharingOutsideRestrictedAccessControlGroups ] + [-CoreRequestFilesLinkEnabled ] [-CoreRequestFilesLinkExpirationInDays ] + [-CoreDefaultShareLinkScope ] [-CoreDefaultShareLinkRole ] + [-CoreDefaultLinkToExistingAccess ] [-CoreBlockGuestsAsSiteAdmin ] + [-AllowAnonymousMeetingParticipantsToAccessWhiteboards ] [-Workflows2013Enabled ] + [-IsFluidEnabled ] [-IsWBFluidEnabled ] [-IsCollabMeetingNotesFluidEnabled ] + [-IsLoopEnabled ] [-DisableDocumentLibraryDefaultLabeling ] + [-ExtendPermissionsToUnprotectedFiles ] [-EnableSensitivityLabelForPDF ] + [-BlockSendLabelMismatchEmail ] [-LabelMismatchEmailHelpLink ] + [-BlockUserInfoVisibility ] [-BlockUserInfoVisibilityInOneDrive ] + [-BlockUserInfoVisibilityInSharePoint ] + [-AllowOverrideForBlockUserInfoVisibility ] [-DisablePersonalListCreation ] + [-DisableSpacesActivation ] [-DisableVivaConnectionsAnalytics ] + [-InformationBarriersSuspension ] [-IBImplicitGroupBased ] + [-AppBypassInformationBarriers ] [-DefaultOneDriveInformationBarrierMode ] + [-AppAccessInformationBarriersAllowList ] [-AllOrganizationSecurityGroupId ] + [-DisableModernListTemplateIds ] [-EnableModernListTemplateIds ] + [-HideSyncButtonOnTeamSite ] [-AllowGuestUserShareToUsersNotInSiteCollection ] + [-StreamLaunchConfig ] [-DelegateRestrictedContentDiscoverabilityManagement ] + [-DelegateRestrictedAccessControlManagement ] [-DisableOutlookPSTVersionTrimming ] + [-MediaTranscription ] + [-MediaTranscriptionAutomaticFeatures ] + [-ViewInFileExplorerEnabled ] [-AuthContextResilienceMode ] + [-ReduceTempTokenLifetimeEnabled ] [-ReduceTempTokenLifetimeValue ] + [-ShowOpenInDesktopOptionForSyncedFiles ] [-ShowPeoplePickerGroupSuggestionsForIB ] + [-EnableRestrictedAccessControl ] [-BlockDownloadFileTypePolicy ] + [-BlockDownloadFileTypeIds ] [-ExcludedBlockDownloadGroupIds ] + [-TlsTokenBindingPolicyValue ] [-RecycleBinRetentionPeriod ] + [-IsEnableAppAuthPopUpEnabled ] [-IsDataAccessInCardDesignerEnabled ] + [-MassDeleteNotificationDisabled ] [-EnableAutoExpirationVersionTrim ] + [-EnableMediaReactions ] [-BusinessConnectivityServiceDisabled ] + [-ExpireVersionsAfterDays ] [-MajorVersionLimit ] [-AllowSensitivityLabelOnRecords ] + [-DelayDenyAddAndCustomizePagesEnforcement ] + [-DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites ] + [-AllowClassicPublishingSiteCreation ] [-WhoCanShareAnonymousAllowList ] + [-WhoCanShareAuthenticatedGuestAllowList ] + [-ResyncContentSecurityPolicyConfigurationEntries ] [-ContentSecurityPolicyEnforcement ] + [-DocumentUnderstandingModelScope ] + [-DocumentUnderstandingModelSelectedSitesList ] + [-DocumentUnderstandingModelSelectedSitesListOperation ] + [-AIBuilderModelScope ] [-AIBuilderModelSelectedSitesList ] + [-AIBuilderModelSelectedSitesListOperation ] + [-AIBuilderModelSelectedSitesIncludesContentCenters ] [-PrebuiltModelScope ] + [-PrebuiltModelSelectedSitesList ] + [-PrebuiltModelSelectedSitesListOperation ] + [-DocumentTranslationScope ] [-DocumentTranslationSelectedSitesList ] + [-DocumentTranslationSelectedSitesListOperation ] + [-AutofillColumnsScope ] [-AutofillColumnsSelectedSitesList ] + [-AutofillColumnsSelectedSitesListOperation ] + [-OpticalCharacterRecognitionScope ] + [-OpticalCharacterRecognitionSelectedSitesList ] + [-OpticalCharacterRecognitionSelectedSitesListOperation ] + [-DefaultContentCenterSite ] + [-AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled ] [-EnforceRequestDigest ] [] ``` @@ -331,7 +572,7 @@ This example sets automatic version history limits on all new document libraries Set-SPOTenant -EnableAutoExpirationVersionTrim $false -MajorVersionLimit 500 -ExpireVersionsAfterDays 30 ``` -This example sets manual version history limits on all new document libraries at tenant level by limiting the number of major versions and the time (in days) versions are kept. +This example sets manual version history limits on all new document libraries at tenant level by limiting the number of major versions and the time (in days) versions are kept. ### EXAMPLE 13 @@ -389,16 +630,16 @@ Use of this parameter requires the tenant to either have the required license or ### EXAMPLE 19 ```powershell -$list = (Get-SPOTenant | Select-Object WhoCanShareAnonymousAllowList).WhoCanShareAnonymousAllowList -Set-SPOTenant –WhoCanShareAnonymousAllowList ($list + ) -``` +$list = (Get-SPOTenant | Select-Object WhoCanShareAnonymousAllowList).WhoCanShareAnonymousAllowList +Set-SPOTenant –WhoCanShareAnonymousAllowList ($list + ) +``` This example appends a security group to the WhoCanShareAnonymousAllowList. Similar code works for the WhoCanShareAuthenticatedGuestAllowList. ### EXAMPLE 20 ```powershell -Set-SPOTenant –WhoCanShareAnonymousAllowList @() +Set-SPOTenant –WhoCanShareAnonymousAllowList @() ``` This example empties the WhoCanShareAnonymousAllowList. Similar code works for the WhoCanShareAuthenticatedGuestAllowList. @@ -417,71 +658,61 @@ This example disables the Power Apps Adaptive Card Extension. 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: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplyAppEnforcedRestrictionsToAdHocRecipients - -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: - -- False (default) - Guest access users are exempt from conditional access policy. -- True - Conditional access policy is also applied to guest users. +### -AllowAnonymousMeetingParticipantsToAccessWhiteboards +{{ Fill AllowAnonymousMeetingParticipantsToAccessWhiteboards Description }} ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Client.SharingState Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BccExternalSharingInvitations +### -AllowClassicPublishingSiteCreation -When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. +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: +The valid values are: -- False (default) - BCC for external sharing is disabled. -- True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. +* False (default) - Classic publishing site collections cannot be created and the publishing features cannot be activated in sites. +* True - Classic publishing site collections can be created and the publishing features can be activated in sites. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BccExternalSharingInvitationsList - -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. +### -AllowCommentsTextOnEmailEnabled -The valid values are: +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. -- "" (default) - Blank by default, this will also clear any value that has been set. -- Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com +PARAMVALUE: True | False ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -492,156 +723,144 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockDownloadLinksFileType - -The valid values are: +### -AllowDownloadingNonWebViewableFiles -- WebPreviewableFiles -- ServerRenderedFilesOnly - -**Note**: ServerRendered (Office Only) and WebPreviewable (All supported files). +This parameter has been deprecated. ```yaml -Type: BlockDownloadLinksFileTypes +Type: Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: WebPreviewableFiles +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BusinessConnectivityServiceDisabled -Prevents access to features that depend on the Business Connectivity Service (BCS), including external lists, external columns, and external content types. +### -AllowEditing + +Prevents users from editing Office files in the browser and copying and pasting Office file contents out of the browser window. PARAMVALUE: True | False ```yaml -Type: Boolean -Parameter Sets: (All) +Type: System.Boolean +Parameter Sets: ParamSetMultipleSites Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DelegateRestrictedAccessControlManagement - -Allows SharePoint administrators to delegate the management of Restricted access control policy on sites to site admins and owners. +### -AllowEveryoneExceptExternalUsersClaimInPrivateSite -The valid values are: +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. -- True - Allow site admins and owners to manage Restricted access control policy +The valid values are: -- False (default) - Do not allow site admins and owners to manage Restricted access control policy +- True - The "Everyone except external users" claim is available in People Picker of a private site. +- False (default) - The "Everyone except external users" claim is not available in People Picker of a private site. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DelegateRestrictedContentDiscoverabilityManagement +### -AllowGuestUserShareToUsersNotInSiteCollection -Allows SharePoint administrators to delegate the management of Restricted content discoverability policy on sites to site admins and owners. +The AllowGuestUserShareToUsersNotInSiteCollection settings (defaulted to false) will allow guests to share to users not in the site. -The valid values are: +The valid values are: -- True - Allow site admins and owners to manage Restricted content discoverability policy +- False (default) – Guest users will only be able to share to users that exist within the current site. +- True – Guest users will be able to find user accounts in the directory by typing in the exact email address match. -- False (default) - Do not allow site admins and owners to manage Restricted content discoverability policy +Note: When the value is set to True, you will also need to enable [SharePoint and OneDrive integration with Microsoft Entra B2B](/sharepoint/sharepoint-azureb2b-integration) for the functionality to work. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayStartASiteOption +### -AllowOverrideForBlockUserInfoVisibility -Determines whether tenant users see the Start a Site menu option. +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: +The valid values are: -- True (default) - Tenant users will see the Start a Site menu option. -- False - Start a Site is hidden from the menu. +- False (default) – Do not allow the Block User Info Visibility policy to be overridden for a SharePoint site or OneDrive. + +- True – Allow the Block User Info Visibility policy to be overridden for a SharePoint site or OneDrive. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAIPIntegration - -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 +### -AllowSensitivityLabelOnRecords +{{ Fill AllowSensitivityLabelOnRecords Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMinimumVersionRequirement - -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 +### -AllowSharingOutsideRestrictedAccessControlGroups +{{ Fill AllowSharingOutsideRestrictedAccessControlGroups Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePromotedFileHandlers - -This parameter is reserved for Microsoft internal use. - -PARAMVALUE: True | False +### -AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled +{{ Fill AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -649,60 +868,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MarkNewFilesSensitiveByDefault - -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 - -- BlockExternalSharing: Prevents guests from accessing newly added files until at least one Office DLP policy scans the content of the file. -- AllowExternalSharing: Disables this feature. - -For more information see [Mark new files as sensitive by default](https://learn.microsoft.com/sharepoint/sensitive-by-default). +### -AnyoneLinkTrackUsers +{{ Fill AnyoneLinkTrackUsers Description }} ```yaml -Type: SensitiveByDefaultState +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: AllowExternalSharing +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalServicesEnabled - -Enables external services for a tenant. -External services are defined as services that are not in the Office 365 datacenters. - -The valid values are: - -- True (default) - External services are enabled for the tenant. -- False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint. +### -AppAccessInformationBarriersAllowList +{{ Fill AppAccessInformationBarriersAllowList Description }} ```yaml -Type: Boolean +Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCompatibilityLevel - -The only valid value is "15". +### -AppBypassInformationBarriers +{{ Fill AppBypassInformationBarriers Description }} ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -710,12 +913,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinCompatibilityLevel +### -ApplyAppEnforcedRestrictionsToAdHocRecipients -The only valid value is "15". +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: + +- False (default) - Guest access users are exempt from conditional access policy. +- True - Conditional access policy is also applied to guest users. ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -726,20 +934,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoAccessRedirectUrl - -Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess." - -The valid values are: - -- "" (default) - Blank by default, this will also remove or clear any value that has been set. -- Full URL - Example: +### -AppOnlyBypassPeoplePickerPolicies +{{ Fill AppOnlyBypassPeoplePickerPolicies Description }} ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -747,215 +949,214 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OfficeClientADALDisabled - -When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. - -The valid values are: - -- False (default) - Modern Authentication is enabled/allowed. -- True - Modern Authentication via ADAL is disabled. +### -ArchiveRedirectUrl +{{ Fill ArchiveRedirectUrl Description }} ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProvisionSharedWithEveryoneFolder - -Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. - -The valid values are: - -- True (default) - The Shared with Everyone folder is created. -- False - No folder is created when the site and OneDrive for Business document library is created. - -The default behavior of the Shared with Everyone folder changed in August 2015. +### -AuthContextResilienceMode +{{ Fill AuthContextResilienceMode Description }} ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Administration.SPResilienceModeType Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireAcceptingAccountMatchInvitedAccount - -This parameter has been deprecated since SharePoint Online legacy invitation flow switched to Entra B2B invitation flow. - -### -SearchResolveExactEmailOrUPN - -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. - -The valid values are: - -- False (default) - Starts with / partial name search functionality is available. -- True - Disables starts with for all users/partial name search functionality for all SharePoint users, except SharePoint Admins. +### -AutofillColumnsScope +{{ Fill AutofillColumnsScope Description }} ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantAdministration.SyntexFeatureScopeValue Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingCapability +### -AutofillColumnsSelectedSitesList +{{ Fill AutofillColumnsSelectedSitesList Description }} -Determines what level of sharing is available for OneDrive and SharePoint sites. - -The valid values are: +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: -- ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. -- Disabled - External user sharing (share by email) and guest link sharing are both disabled. -- ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. -- ExistingExternalUserSharingOnly - Only guests already in your organization's directory. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -For more information about sharing, see [Manage sharing settings](/sharepoint/turn-external-sharing-on-or-off) for your SharePoint online environment. +### -AutofillColumnsSelectedSitesListOperation +{{ Fill AutofillColumnsSelectedSitesListOperation Description }} ```yaml -Type: SharingCapabilities +Type: Microsoft.Online.SharePoint.TenantAdministration.SelectedSitesListOperations Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: ExternalUserAndGuestSharing +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAllUsersClaim - -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. +### -BccExternalSharingInvitations -Note, the All Users (authenticated) group is equivalent to the Everyone claim, and shows as Everyone. -To change this, see -ShowEveryoneClaim. +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: +The valid values are: -- True (default) - The All Users claim groups are displayed in People Picker. -- False - The All Users claim groups are hidden in People Picker. +- False (default) - BCC for external sharing is disabled. +- True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowEveryoneClaim - -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. +### -BccExternalSharingInvitationsList -Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. +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. -The valid values are: +The valid values are: -- True - The Everyone claim group is displayed in People Picker. This has been the default for tenants older than March 2018 -- False (default) - The Everyone claim group is hidden from the People Picker. This has become the new default for new tenants. +- "" (default) - Blank by default, this will also clear any value that has been set. +- Single or Multiple e-mail addresses - joe@contoso.com or joe@contoso.com,bob@contoso.com ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowEveryoneExceptExternalUsersClaim +### -BlockAppAccessWithAuthenticationContext +{{ Fill BlockAppAccessWithAuthenticationContext Description }} -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. +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: -The valid values are: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- True (default) - The Everyone except external users is displayed in People Picker. -- False - The Everyone except external users claim is not visible in People Picker. +### -BlockDownloadFileTypeIds +{{ Fill BlockDownloadFileTypeIds Description }} ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Client.Administration.SPBlockDownloadFileTypeId[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEveryoneExceptExternalUsersClaimInPrivateSite +### -BlockDownloadFileTypePolicy +{{ Fill BlockDownloadFileTypePolicy Description }} -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. +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: -The valid values are: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- True - The "Everyone except external users" claim is available in People Picker of a private site. -- False (default) - The "Everyone except external users" claim is not available in People Picker of a private site. +### -BlockDownloadLinksFileType + +The valid values are: + +- WebPreviewableFiles +- ServerRenderedFilesOnly + +**Note**: ServerRendered (Office Only) and WebPreviewable (All supported files). ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.BlockDownloadLinksFileTypes Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SignInAccelerationDomain - -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. -This value can also be used with Microsoft Entra ID P1 or P2 to customize the Microsoft Entra sign-in page. +### -BlockSendLabelMismatchEmail -Acceleration will not occur on site collections that are shared externally. +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. -This value should be configured with the login domain that is used by your company (that is, example@contoso.com). +PARAMVALUE: True | False -If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The valid values are: +### -BlockUserInfoVisibility -- "" (default) - Blank by default, this will also remove or clear any value that has been set. -- Login Domain - For example: "contoso.com" +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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -966,17 +1167,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartASiteFormUrl +### -BlockUserInfoVisibilityInOneDrive -Specifies URL of the form to load in the Start a Site dialog. +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: +The valid values are: -- "" (default) - Blank by default, this will also remove or clear any value that has been set. -- Full URL - Example: " +- ApplyToNoUsers – No users are prevented from accessing User Info when they have Limited Access permission only. + +- ApplyToAllUsers – All users (internal or external) are prevented from accessing User Info if they have Limited Access permission only. + +- ApplyToGuestAndExternalUsers (default) – Only external or guest users are prevented from accessing User Info if they have Limited Access permission only. + +- ApplyToInternalUsers – Only internal users are prevented from accessing User Info if they have Limited Access permission only. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.TenantAdministration.TenantBrowseUserInfoPolicyValue Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -987,42 +1193,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UsePersistentCookiesForExplorerView -> [!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. - -Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. - -"Open with Explorer" requires persisted cookies to operate correctly. -When the user does not select "Keep Me Signed in" at the time of sign-in, "Open with Explorer" will fail. - -This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online. -To clear this cookie, the user must log out of their Windows session. +### -BlockUserInfoVisibilityInSharePoint -The valid values are: +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. -- False (default) - No special cookie is generated and the normal Office 365 sign-in length/timing applies. -- True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign-in. +The valid values are: +- ApplyToNoUsers (default) – No users are prevented from accessing User Info when they have Limited Access permission only to a SharePoint site. +- ApplyToAllUsers – All users (internal or external) are prevented from accessing User Info if they have Limited Access permission only to a SharePoint site. +- ApplyToGuestAndExternalUsers – Only external or guest users are prevented from accessing User Info if they have Limited Access permission only to a SharePoint site. +- ApplyToInternalUsers – Only internal users are prevented from accessing User Info if they have Limited Access permission only to a SharePoint site. ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantAdministration.TenantBrowseUserInfoPolicyValue Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CommentsOnSitePagesDisabled +### -BusinessConnectivityServiceDisabled +Prevents access to features that depend on the Business Connectivity Service (BCS), including external lists, external columns, and external content types. -Disables or enables commenting functionality on the site pages. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1039,7 +1238,7 @@ Disables or enables commenting functionality on the files. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1056,76 +1255,76 @@ Disables or enables commenting functionality on list items. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SocialBarOnSitePagesDisabled - -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. +### -CommentsOnSitePagesDisabled +Disables or enables commenting functionality on the site pages. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultLinkPermission +### -ConditionalAccessPolicy -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. +Please read [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices ) documentation here to understand Conditional Access Policy usage in SharePoint Online. -The valid values are View and Edit (default). +PARAMVALUE: AllowFullAccess | AllowLimitedAccess | BlockAccess ```yaml -Type: SharingPermissionType -Parameter Sets: (All) +Type: Microsoft.Online.SharePoint.TenantManagement.SPOConditionalAccessPolicyType +Parameter Sets: ParamSetMultipleSites Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Edit +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultSharingLinkType - -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. +### -ConditionalAccessPolicyErrorHelpLink -> [!NOTE] -> Setting this value to "none" will default "get a link" to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. +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://. -The valid values are: +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- None - Respect the organization default sharing link type -- Direct - Sets the default sharing link for this site to the Specific people link -- Internal - Sets the default sharing link for this site to the organization link or company shareable link -- AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link +### -ContentSecurityPolicyEnforcement +{{ Fill ContentSecurityPolicyEnforcement Description }} ```yaml -Type: SharingLinkType +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1133,50 +1332,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisabledWebPartIds +### -ContentTypeSyncSiteTemplatesList -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: +By default Content Type Hub will no longer push content types to OneDrive for Business sites (formerly known as MySites). -- Amazon Kindle: 46698648-fcd5-41fc-9526-c7f7b2ace919 -- YouTube: 544dd15b-cf3c-441b-96da-004d5a8cea1d -- Twitter: f6fdf4f8-4a24-437b-a127-32e66a5dd9b4 -- Embed: 490d7c76-1824-45b2-9de3-676421c997fa -- Microsoft Bookings: d24a7165-c455-4d43-8bc8-fedb04d6c1b5 -- Stream: 275c0095-a77e-4f6d-a2a0-6a7626911518 +In case you want the Content Type Hub to push content types to OneDrive for Business sites, use: `Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites`. -To disable a specific web part, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them, for example Set-SPOTenant -DisabledWebPartIds 46698648-fcd5-41fc-9526-c7f7b2ace919,544dd15b-cf3c-441b-96da-004d5a8cea1d. To view a list of disabled web parts, use Get-SPOTenant to get DisabledWebPartIds. +When the feature is enabled, the Content Type Hub will push content types to OneDrive for Business sites. -To re-enable some disabled web parts, use the Set-SPOTenant with the -DisabledWebPartIds parameter and corresponding GUIDs that you still want to keep disabling. To re-enable all disabled web parts, use Set-SPOTenant -DisabledWebPartIds @(). +Once you have enabled Content Type publishing to OneDrive for Business sites, you can disable it later using: `Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -ExcludeSiteTemplate`. ```yaml -Type: Guid[] -Parameter Sets: (All) +Type: System.String[] +Parameter Sets: ParameterSetContentTypeSyncSiteTemplatesList Aliases: -Applicable: SharePoint Online -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisabledAdaptiveCardExtensionIds - -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: +### -CoreBlockGuestsAsSiteAdmin +{{ Fill CoreBlockGuestsAsSiteAdmin Description }} -| Adaptive Card Extension Name | GUID | -|---|---| -| Power Apps | 0d2d0fd0-9489-47ef-acfb-90edca009cba | +```yaml +Type: Microsoft.SharePoint.Client.SharingState +Parameter Sets: (All) +Aliases: -To disable a specific Adaptive Card Extension, you need to enter its GUID as the parameter. To view a list of disabled Adaptive Card Extensions, use [Get-SPOTenant](Get-SPOTenant.md) to get `DisabledAdaptiveCardExtensionIds`. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -To re-enable some disabled Adaptive Card Extensions, use the `Set-SPOTenant` with the `-DisabledAdaptiveCardExtensionIds` parameter and corresponding GUIDs that you still want to keep disabling. To re-enable all disabled Adaptive Card Extensions, use `Set-SPOTenant -DisabledAdaptiveCardExtensionIds @()`. +### -CoreDefaultLinkToExistingAccess +{{ Fill CoreDefaultLinkToExistingAccess Description }} ```yaml -Type: Guid[] +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1184,17 +1383,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisallowInfectedFileDownload +### -CoreDefaultShareLinkRole +{{ Fill CoreDefaultShareLinkRole Description }} -Prevents the Download button from being displayed on the Virus Found warning page. +```yaml +Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole +Parameter Sets: (All) +Aliases: -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. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CoreDefaultShareLinkScope +{{ Fill CoreDefaultShareLinkScope Description }} ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1202,14 +1413,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableSharePointStoreAccess +### -CoreLoopDefaultSharingLinkRole -This feature allows the SharePoint Administrators to disable SharePoint Store access for all users in the tenant. +This parameter sets the default share link role for Loop and Whiteboard files on SharePoint sites. -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. +The valid values are: + +- Edit +- View +- None +- Review +- RestrictedView ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1220,14 +1437,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableCustomAppAuthentication +### -CoreLoopDefaultSharingLinkScope -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. +This parameter sets the default share link scope for Loop and Whiteboard files on SharePoint sites. -Accepts a value of true or false. By default this feature is set to true. +The valid values are: + +- Anyone +- Organization +- SpecificPeople +- Uninitialized ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1238,20 +1460,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsSharePointAddInsDisabled - -When the feature is enabled, all the add-ins features will be disabled. - -The valid values are: - -- False (default) - All the add-ins features are supported. -- True - All the add-ins features will be disabled. +### -CoreRequestFilesLinkEnabled +{{ Fill CoreRequestFilesLinkEnabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1259,20 +1475,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsSharePointAddInsBlocked +### -CoreRequestFilesLinkExpirationInDays +{{ Fill CoreRequestFilesLinkExpirationInDays Description }} -When this feature is enabled, all functionalities of the add-ins will be restricted, preventing them from running or installing. +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: -The valid values are: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -- False (default) - All the add-ins features are supported. -- True - All the add-ins features will be blocked. +### -CoreSharingCapability +{{ Fill CoreSharingCapability Description }} ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SharingCapabilities Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1280,36 +1505,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteOwnerManageLegacyServicePrincipalEnabled - -Allows or disallows the site collection admins to manage the Azure Access Control (ACS) service principal. +### -CustomizedExternalSharingServiceUrl -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. +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: Boolean +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableGuestSignInAcceleration - -Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. - -> [!NOTE] -> If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them. +### -DefaultContentCenterSite +{{ Fill DefaultContentCenterSite Description }} ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1317,17 +1536,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileAnonymousLinkType - -Anonymous access links can allow recipients to only view or view and edit. The value can be set separately for folders and files. +### -DefaultLinkPermission -The valid values are: +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. -- View -- Edit +The valid values are View and Edit (default). ```yaml -Type: AnonymousLinkType +Type: Microsoft.Online.SharePoint.TenantManagement.SharingPermissionType Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1338,34 +1554,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FilePickerExternalImageSearchEnabled - -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). +### -DefaultOneDriveInformationBarrierMode +{{ Fill DefaultOneDriveInformationBarrierMode Description }} ```yaml -Type: Boolean -Parameter Sets: (All) +Type: System.String +Parameter Sets: InformationBarrier Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FolderAnonymousLinkType +### -DefaultSharingLinkType -Users can configure folder anonymous access links that allow recipients to view, view and upload, or view, edit, and upload files. +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. + +> [!NOTE] +> Setting this value to "none" will default "get a link" to the most permissive link available (that is, if anonymous links are enabled, the default link will be anonymous access; if they are disabled then the default link will be internal. The valid values are: -- View -- ViewUpload -- Edit +- None - Respect the organization default sharing link type +- Direct - Sets the default sharing link for this site to the Specific people link +- Internal - Sets the default sharing link for this site to the organization link or company shareable link +- AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link ```yaml -Type: AnonymousLinkType +Type: Microsoft.Online.SharePoint.TenantManagement.SharingLinkType Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1376,20 +1597,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAddressAllowList +### -DelayDenyAddAndCustomizePagesEnforcement +{{ Fill DelayDenyAddAndCustomizePagesEnforcement Description }} -Configures multiple IP addresses or IP address ranges (IPv4 or IPv6), that are recognized as trusted. +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: -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. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -> [!NOTE] -> The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true. +### -DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites +{{ Fill DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites Description }} ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1397,16 +1627,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAddressEnforcement - -Allows access from network locations that are defined by an administrator. +### -DelegateRestrictedAccessControlManagement -The values are $true and $false. The default value is $false which means the setting is disabled. +Allows SharePoint administrators to delegate the management of Restricted access control policy on sites to site admins and owners. -Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter. +The valid values are: +- True - Allow site admins and owners to manage Restricted access control policy +- False (default) - Do not allow site admins and owners to manage Restricted access control policy ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1417,14 +1647,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IPAddressWACTokenLifetime +### -DelegateRestrictedContentDiscoverabilityManagement -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. +Allows SharePoint administrators to delegate the management of Restricted content discoverability policy on sites to site admins and owners. -PARAMVALUE: Int32 +The valid values are: +- True - Allow site admins and owners to manage Restricted content discoverability policy +- False (default) - Do not allow site admins and owners to manage Restricted content discoverability policy ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1435,20 +1667,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegacyAuthProtocolsEnabled - -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. +### -DisableAddShortcutsToOneDrive -- True - Enables Office clients using non-modern authentication protocols (such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. -- False - Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. +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. -> [!NOTE] -> • This may also prevent third-party apps from accessing SharePoint Online resources.
Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources. For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class.

• The change is not instant. It might take up to 24 hours to be applied. +PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1459,54 +1685,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaTranscription - -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: - -- Enabled -- Disabled +### -DisableBackToClassic +{{ Fill DisableBackToClassic Description }} ```yaml -Type: MediaTranscriptionPolicyType +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MediaTranscriptionAutomaticFeatures +### -DisableCustomAppAuthentication -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: +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. -- Enabled -- Disabled +Accepts a value of true or false. By default this feature is set to true. ```yaml -Type: MediaTranscriptionAutomaticFeaturesPolicyType +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Enabled +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationsInOneDriveForBusinessEnabled +### -DisabledAdaptiveCardExtensionIds -Enables or disables notifications in OneDrive for Business. +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: -PARAMVALUE: True | False +| Adaptive Card Extension Name | GUID | +|---|---| +| Power Apps | 0d2d0fd0-9489-47ef-acfb-90edca009cba | + +To disable a specific Adaptive Card Extension, you need to enter its GUID as the parameter. To view a list of disabled Adaptive Card Extensions, use [Get-SPOTenant](Get-SPOTenant.md) to get `DisabledAdaptiveCardExtensionIds`. + +To re-enable some disabled Adaptive Card Extensions, use the `Set-SPOTenant` with the `-DisabledAdaptiveCardExtensionIds` parameter and corresponding GUIDs that you still want to keep disabling. To re-enable all disabled Adaptive Card Extensions, use `Set-SPOTenant -DisabledAdaptiveCardExtensionIds @()`. ```yaml -Type: Boolean +Type: System.Guid[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1517,14 +1742,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationsInSharePointEnabled +### -DisableDocumentLibraryDefaultLabeling -Enables or disables notifications in SharePoint. +This switch allows tenant admins to disable the capability of configuring a default sensitivity label for a document library. PARAMVALUE: True | False +> [!NOTE] +> When set to $true, users aren't able to apply a default sensitivity label for a document library. The default value is false. + ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1535,20 +1763,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyOwnersWhenInvitationsAccepted - -This parameter has been deprecated since SharePoint Online legacy invitation flow switched to Entra B2B invitation flow. +### -DisabledWebPartIds -### -NotifyOwnersWhenItemsReshared +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: -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. +- Amazon Kindle: 46698648-fcd5-41fc-9526-c7f7b2ace919 +- YouTube: 544dd15b-cf3c-441b-96da-004d5a8cea1d +- Twitter: f6fdf4f8-4a24-437b-a127-32e66a5dd9b4 +- Embed: 490d7c76-1824-45b2-9de3-676421c997fa +- Microsoft Bookings: d24a7165-c455-4d43-8bc8-fedb04d6c1b5 +- Stream: 275c0095-a77e-4f6d-a2a0-6a7626911518 -For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. +To disable a specific web part, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them, for example Set-SPOTenant -DisabledWebPartIds 46698648-fcd5-41fc-9526-c7f7b2ace919,544dd15b-cf3c-441b-96da-004d5a8cea1d. To view a list of disabled web parts, use Get-SPOTenant to get DisabledWebPartIds. -The valid values are $true and $false. +To re-enable some disabled web parts, use the Set-SPOTenant with the -DisabledWebPartIds parameter and corresponding GUIDs that you still want to keep disabling. To re-enable all disabled web parts, use Set-SPOTenant -DisabledWebPartIds @(). ```yaml -Type: Boolean +Type: System.Guid[] Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1559,21 +1790,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ODBAccessRequests - -Lets administrators set policy on access requests and requests to share in OneDrive for Business. - -The valid values are: - -- On - Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. -- Off - Prevent access requests and requests to share on OneDrive for Business. -- Unspecified - Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive. +### -DisableModernListTemplateIds +{{ Fill DisableModernListTemplateIds Description }} ```yaml -Type: SharingState +Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1581,18 +1805,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ODBMembersCanShare - -Lets administrators set policy on re-sharing behavior in OneDrive for Business. +### -DisableOutlookPSTVersionTrimming -The valid values are: +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. -- On - Users with edit permissions can re-share. -- Off - Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. -- Unspecified - Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive. +PARAMVALUE: True | False ```yaml -Type: SharingState +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1603,20 +1824,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveForGuestsEnabled - -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: - -- $true - Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. -- $false - Administrator managed Guest users can't be given OneDrives as functionality is turned off. +### -DisablePersonalListCreation +{{ Fill DisablePersonalListCreation Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1624,18 +1839,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveStorageQuota - -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. +### -DisableSharePointStoreAccess -If value is set to 0, the parameter will have no effect. +This feature allows the SharePoint Administrators to disable SharePoint Store access for all users in the tenant. -If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect. +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. ```yaml -Type: Int64 +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1646,20 +1857,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsWBFluidEnabled - -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: - -- $true - Administrator enabled Whiteboard for user with OneDrive for Business Users. -- $false - Administrator disable Whiteboard for user with OneDrive for Business Users. +### -DisableSpacesActivation +{{ Fill DisableSpacesActivation Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1667,17 +1872,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrphanedPersonalSitesRetentionPeriod - -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. +### -DisableVivaConnectionsAnalytics +{{ Fill DisableVivaConnectionsAnalytics Description }} ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1685,17 +1887,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OwnerAnonymousNotification - -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 +### -DisableWorkflow2010 +{{ Fill DisableWorkflow2010 Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1703,17 +1902,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PermissiveBrowserFileHandlingOverride - -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. +### -DisallowInfectedFileDownload -The valid values are: +Prevents the Download button from being displayed on the Virus Found warning page. -- True - Enable the Permissive browser file handling setting. -- False - Keep the default Strict browser file handling setting. +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. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1724,14 +1920,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreventExternalUsersFromResharing +### -DisplayStartASiteOption -Prevents external users from resharing files, folders, and sites that they do not own. +Determines whether tenant users see the Start a Site menu option. -PARAMVALUE: True | False +The valid values are: + +- True (default) - Tenant users will see the Start a Site menu option. +- False - Start a Site is hidden from the menu. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1742,17 +1941,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublicCdnAllowedFileTypes - -Sets public CDN allowed file types, if the public CDN is enabled. - -PARAMVALUE: String +### -DocumentTranslationScope +{{ Fill DocumentTranslationScope Description }} ```yaml -Type: String +Type: Microsoft.Online.SharePoint.TenantAdministration.SyntexFeatureScopeValue Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1760,17 +1956,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublicCdnEnabled - -Enables or disables the public CDN. - -PARAMVALUE: True | False +### -DocumentTranslationSelectedSitesList +{{ Fill DocumentTranslationSelectedSitesList Description }} ```yaml -Type: Boolean +Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1778,19 +1971,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireAnonymousLinksExpireInDays - -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. - -To remove the expiration requirement, set the value to zero (0). +### -DocumentTranslationSelectedSitesListOperation +{{ Fill DocumentTranslationSelectedSitesListOperation Description }} ```yaml -Type: Int32 +Type: Microsoft.Online.SharePoint.TenantAdministration.SelectedSitesListOperations Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1798,19 +1986,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireOrganizationLinksExpireInDays - -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. - -To remove the expiration requirement, set the value to zero (0). +### -DocumentUnderstandingModelScope +{{ Fill DocumentUnderstandingModelScope Description }} ```yaml -Type: Int32 +Type: Microsoft.Online.SharePoint.TenantAdministration.SyntexFeatureScopeValue Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1818,17 +2001,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingAllowedDomainList - -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). +### -DocumentUnderstandingModelSelectedSitesList +{{ Fill DocumentUnderstandingModelSelectedSitesList Description }} ```yaml -Type: String +Type: System.String[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1836,17 +2016,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingBlockedDomainList - -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). +### -DocumentUnderstandingModelSelectedSitesListOperation +{{ Fill DocumentUnderstandingModelSelectedSitesListOperation Description }} ```yaml -Type: String +Type: Microsoft.Online.SharePoint.TenantAdministration.SelectedSitesListOperations Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1854,20 +2031,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharingDomainRestrictionMode - -Specifies the external sharing mode for domains. - -The valid values are: - -- None -- AllowList - Users will be able to share with external collaborators coming only from that email domain. -- BlockList - Users will be able to share with all external collaborators apart from the ones on the BlockedDomainList. +### -EmailAttestationReAuthDays -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). +Sets the number of days for email attestation re-authentication. Value can be from 1 to 365 days. ```yaml -Type: SharingDomainRestrictionModes +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1878,39 +2047,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowPeoplePickerSuggestionsForGuestUsers +### -EmailAttestationRequired -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. +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. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SpecialCharactersStateInFileFolderNames - -Permits the use of special characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. - -> [!NOTE] -> The only two characters that can be managed at this time are the # and % characters. +### -EnableAIPIntegration -The valid values are: +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). -- NoPreference - Support for feature will be enabled by Microsoft on your Office 365 tenant. -- Allowed - Lets the # and % characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. -- Disallowed - Disallows the # and % characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. +PARAMVALUE: True | False ```yaml -Type: SpecialCharactersState +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1921,21 +2085,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReSyncTenantPrivacyProfile - -The 'SyncPrivacyProfileProperties' parameter is obsolete and renamed ReSyncTenantPrivacyProfile. - -This parameter enables the synchronization of privacy profile properties. - -ReSyncTenantPrivacyProfile sets whether or not the synced tenant properties will be updated on the next request. The request will cause Microsoft Entra ID to grab the tenant's current display name (TenantDisplayName) and privacy profile URL (PrivacyProfileUrl). - -Running 'Set-SPOTenant - ReSyncTenantPrivacyProfile' will force a sync from the Microsoft Entra privacy profile URL to SharePoint Online. The sync may take up to 24 hours to complete. Whenever SharePoint Online gets the privacy profile URL, it checks whether the last sync time is out of the sync time window. If it is, it syncs from Microsoft Entra ID to SharePoint Online. +### -EnableAutoExpirationVersionTrim +{{ Fill EnableAutoExpirationVersionTrim Description }} ```yaml -Type: SwitchParameter +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -1943,17 +2100,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseFindPeopleInPeoplePicker +### -EnableAutoNewsDigest -This feature enables tenant admins to enable ODB and SPO to respect Exchange supports Address Book Policy (ABP) policies in the people picker. +Enable or disable auto news digest. [Documentation](https://aka.ms/autonewsdigest) for auto news digest. PARAMVALUE: True | False -> [!NOTE] -> When set to $true, users aren't able to share with security groups or SharePoint groups. - ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -1963,36 +2117,33 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableDocumentLibraryDefaultLabeling -This switch allows tenant admins to disable the capability of configuring a default sensitivity label for a document library. +### -EnableAzureADB2BIntegration -PARAMVALUE: True | False +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). -> [!NOTE] -> When set to $true, users aren't able to apply a default sensitivity label for a document library. The default value is false. +PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomizedExternalSharingServiceUrl - -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 " +### -EnableDiscoverableByOrganizationForVideos +{{ Fill EnableDiscoverableByOrganizationForVideos Description }} ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2000,35 +2151,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ContentTypeSyncSiteTemplatesList [String[]] [-ExcludeSiteTemplate] - -By default Content Type Hub will no longer push content types to OneDrive for Business sites (formerly known as MySites). - -In case you want the Content Type Hub to push content types to OneDrive for Business sites, use: `Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites`. +### -EnableGuestSignInAcceleration -When the feature is enabled, the Content Type Hub will push content types to OneDrive for Business sites. +Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. -Once you have enabled Content Type publishing to OneDrive for Business sites, you can disable it later using: `Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -ExcludeSiteTemplate`. +> [!NOTE] +> If enabled, your identity provider must be capable of authenticating guest users. If it is not, guest users will be unable to log in and access content that was shared with them. ```yaml -Type: String[] -Parameter Sets: ParameterSetContentTypeSyncSiteTemplatesList +Type: System.Boolean +Parameter Sets: (All) Aliases: -Required: True +Applicable: SharePoint Online +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeSiteTemplate +### -EnableMediaReactions +{{ Fill EnableMediaReactions Description }} -Excludes the specified template from Content Type hub content type synchronization. Must be used with `-ContentTypeSyncSiteTemplatesList [String[]]`. - ```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetContentTypeSyncSiteTemplatesList +Type: System.Boolean +Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -2036,33 +2185,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConditionalAccessPolicy +### -EnableMinimumVersionRequirement -Please read [Control access from unmanaged devices](https://learn.microsoft.com/sharepoint/control-access-from-unmanaged-devices ) documentation here to understand Conditional Access Policy usage in 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: AllowFullAccess | AllowLimitedAccess | BlockAccess +PARAMVALUE: True | False ```yaml -Type: SPOConditionalAccessPolicyType -Parameter Sets: ParamSet1 +Type: System.Boolean +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: AllowFullAccess -Accept pipeline input: True +Default value: None +Accept pipeline input: False Accept wildcard characters: False ``` -### -ConditionalAccessPolicyErrorHelpLink - -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 http:// or https://. +### -EnableModernListTemplateIds +{{ Fill EnableModernListTemplateIds Description }} ```yaml -Type: String +Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2070,12 +2218,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDownloadingNonWebViewableFiles +### -EnablePromotedFileHandlers -This parameter has been deprecated. +This parameter is reserved for Microsoft internal use. + +PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2086,162 +2236,130 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowClassicPublishingSiteCreation - -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: - -* False (default) - Classic publishing site collections cannot be created and the publishing features cannot be activated in sites. -* True - Classic publishing site collections can be created and the publishing features can be activated in sites. +### -EnableRestrictedAccessControl +{{ Fill EnableRestrictedAccessControl Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCommentsTextOnEmailEnabled +### -EnableSensitivityLabelforPDF -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. +Allows tenant admins to turn on support for PDFs with sensitivity labels for the following scenarios: -PARAMVALUE: True | False +- Applying a sensitivity label in Office for the web. +- Uploading a labeled document, and then extracting and displaying that sensitivity label. +- Search, eDiscovery, and data loss prevention. +- Auto-labeling policies and default sensitivity labels for SharePoint document libraries. + +The valid values are: + +- True - Enables support for PDFs. +- False (default) - Disables support for PDFs. ```yaml -Type: Boolean -Parameter Sets: ParamSet1 +Type: System.Boolean +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowEditing - -Prevents users from editing Office files in the browser and copying and pasting Office file contents out of the browser window. - -PARAMVALUE: True | False +### -EnableTenantRestrictionsInsights +{{ Fill EnableTenantRestrictionsInsights Description }} ```yaml -Type: Boolean -Parameter Sets: ParamSet1 +Type: System.Boolean +Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAzureADB2BIntegration - -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 +### -EnforceRequestDigest +{{ Fill EnforceRequestDigest Description }} ```yaml -Type: Boolean -Parameter Sets: ParamSet1 +Type: System.Boolean +Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitedAccessFileType - -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. - -- OfficeOnlineFilesOnly: Allows users to preview only Office files in the browser. This option increases security but may be a barrier to user productivity. -- LimitedAccessFileType WebPreviewableFiles (default): Allows users to preview Office files in the browser. This option optimizes for user productivity but offers less security for files that aren't Office files. **Warning:** This option is known to cause problems with PDF and image file types because they can be required to be downloaded to the end user's machine to render in the browser. Plan the use of this control carefully. Otherwise, your users could be faced with unexpected "Access Denied" errors. -- LimitedAccessFileType OtherFiles: Allows users to download files that can't be previewed, such as .zip and .exe. This option offers less security. - -PARAMVALUE: OfficeOnlineFilesOnly | WebPreviewableFiles | OtherFiles +### -ExcludedBlockDownloadGroupIds +{{ Fill ExcludedBlockDownloadGroupIds Description }} ```yaml -Type: SPOLimitedAccessFileType -Parameter Sets: ParamSet1 +Type: System.Guid[] +Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: WebPreviewableFiles +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalUserExpirationRequired - -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. +### -ExcludeSiteTemplate -The valid values are: -True - Enables the Policy. -False (default) - Disables the policy. +Excludes the specified template from Content Type hub content type synchronization. Must be used with `-ContentTypeSyncSiteTemplatesList [String[]]`. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: System.Management.Automation.SwitchParameter +Parameter Sets: ParameterSetContentTypeSyncSiteTemplatesList Aliases: -Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSensitivityLabelforPDF - -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. -- Uploading a labeled document, and then extracting and displaying that sensitivity label. -- Search, eDiscovery, and data loss prevention. -- Auto-labeling policies and default sensitivity labels for SharePoint document libraries. - -The valid values are: - -- True - Enables support for PDFs. -- False (default) - Disables support for PDFs. +### -ExpireVersionsAfterDays +{{ Fill ExpireVersionsAfterDays Description }} ```yaml -Type: Boolean +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalUserExpireInDays - -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. +### -ExtendPermissionsToUnprotectedFiles +{{ Fill ExtendPermissionsToUnprotectedFiles Description }} ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2249,32 +2367,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmailAttestationRequired +### -ExternalServicesEnabled -Sets email attestation to required. +Enables external services for a tenant. +External services are defined as services that are not in the Office 365 datacenters. -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. +The valid values are: -PARAMVALUE: True | False +- True (default) - External services are enabled for the tenant. +- False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EmailAttestationReAuthDays +### -ExternalUserExpirationRequired -Sets the number of days for email attestation re-authentication. Value can be from 1 to 365 days. +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. + +The valid values are: +True - Enables the Policy. +False (default) - Disables the policy. ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2285,142 +2411,122 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockUserInfoVisibility +### -ExternalUserExpireInDays -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. +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: String +Type: Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: ExternalPeopleInOD +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockUserInfoVisibilityInOneDrive - -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: - -- ApplyToNoUsers – No users are prevented from accessing User Info when they have Limited Access permission only. +### -FileAnonymousLinkType -- ApplyToAllUsers – All users (internal or external) are prevented from accessing User Info if they have Limited Access permission only. +Anonymous access links can allow recipients to only view or view and edit. The value can be set separately for folders and files. -- ApplyToGuestAndExternalUsers (default) – Only external or guest users are prevented from accessing User Info if they have Limited Access permission only. +The valid values are: -- ApplyToInternalUsers – Only internal users are prevented from accessing User Info if they have Limited Access permission only. +- View +- Edit ```yaml -Type: String +Type: Microsoft.SharePoint.Client.AnonymousLinkType Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: ApplyToGuestAndExternalUsers +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockUserInfoVisibilityInSharePoint - -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: - -- ApplyToNoUsers (default) – No users are prevented from accessing User Info when they have Limited Access permission only to a SharePoint site. - -- ApplyToAllUsers – All users (internal or external) are prevented from accessing User Info if they have Limited Access permission only to a SharePoint site. - -- ApplyToGuestAndExternalUsers – Only external or guest users are prevented from accessing User Info if they have Limited Access permission only to a SharePoint site. +### -FilePickerExternalImageSearchEnabled -- ApplyToInternalUsers – Only internal users are prevented from accessing User Info if they have Limited Access permission only to a SharePoint site. +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: String +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: ApplyToNoUsers +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOverrideForBlockUserInfoVisibility +### -FolderAnonymousLinkType -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. +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: -- False (default) – Do not allow the Block User Info Visibility policy to be overridden for a SharePoint site or OneDrive. - -- True – Allow the Block User Info Visibility policy to be overridden for a SharePoint site or OneDrive. +- View +- ViewUpload +- Edit ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Client.AnonymousLinkType Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAutoNewsDigest - -Enable or disable auto news digest. [Documentation](https://aka.ms/autonewsdigest) for auto news digest. - -PARAMVALUE: True | False +### -HideSyncButtonOnTeamSite +{{ Fill HideSyncButtonOnTeamSite Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeAtAGlanceInShareEmails - -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 +### -IBImplicitGroupBased +{{ Fill IBImplicitGroupBased Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StopNew2010Workflows +### -IncludeAtAGlanceInShareEmails -Prevents creation of new SharePoint 2010 classic workflows. +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 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: +Applicable: SharePoint Online Required: False Position: Named Default value: None @@ -2428,16 +2534,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StopNew2013Workflows - -Prevents creation of new SharePoint 2013 classic workflows. - -PARAMVALUE: True | False +### -InformationBarriersSuspension +{{ Fill InformationBarriersSuspension Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -2445,32 +2549,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockSendLabelMismatchEmail +### -IPAddressAllowList -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. +Configures multiple IP addresses or IP address ranges (IPv4 or IPv6), that are recognized as trusted. -PARAMVALUE: True | False +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. + +> [!NOTE] +> The IPAddressAllowList parameter only lets administrators set IP addresses or ranges that are recognized as trusted. To only grant access from these IP addresses or ranges, set the IPAddressEnforcement parameter to $true. ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: false +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LabelMismatchEmailHelpLink +### -IPAddressEnforcement -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. +Allows access from network locations that are defined by an administrator. -The value can be any valid URL. +The values are $true and $false. The default value is $false which means the setting is disabled. + +Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter. ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2481,61 +2590,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableOutlookPSTVersionTrimming +### -IPAddressWACTokenLifetime -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. +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: True | False +PARAMVALUE: Int32 ```yaml -Type: Boolean +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableAddShortcutsToOneDrive - -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 +### -IsCollabMeetingNotesFluidEnabled +{{ Fill IsCollabMeetingNotesFluidEnabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewInFileExplorerEnabled - -Enables or disables the ability to use View in Explorer in Microsoft Edge (93) or above. - -> [!NOTE] -> When the value is set the View In Explorer command will become visible in UX for all users using Edge browser version 93 or above however those users still need [ConfigureViewInFileExplorer](https://learn.microsoft.com/deployedge/microsoft-edge-policies#configureviewinfileexplorer) Edge policy enabled for the functionality to work. -> -> Minimum Module Version Required: 16.0.21610.12000 - -The valid values are: - -- False (default) - Disables View In Explorer command to become visible in Edge. -- True - Enables View In Explorer command to become visible in Edge. +### -IsDataAccessInCardDesignerEnabled +{{ Fill IsDataAccessInCardDesignerEnabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: + Required: False Position: Named Default value: None @@ -2543,69 +2638,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowGuestUserShareToUsersNotInSiteCollection - -The AllowGuestUserShareToUsersNotInSiteCollection settings (defaulted to false) will allow guests to share to users not in the site. - -The valid values are: - -- False (default) – Guest users will only be able to share to users that exist within the current site. -- True – Guest users will be able to find user accounts in the directory by typing in the exact email address match. - -Note: When the value is set to True, you will also need to enable [SharePoint and OneDrive integration with Microsoft Entra B2B](/sharepoint/sharepoint-azureb2b-integration) for the functionality to work. +### -IsEnableAppAuthPopUpEnabled +{{ Fill IsEnableAppAuthPopUpEnabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveLoopDefaultSharingLinkScope - -Gets or sets default share link scope for Loop and Whiteboard files on OneDrive sites. - -The valid values are: - -- Anyone -- Organization -- SpecificPeople -- Uninitialized +### -IsFluidEnabled +{{ Fill IsFluidEnabled Description }} ```yaml -Type: SharingScope +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: Uninitialized +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveLoopDefaultSharingLinkRole - -This parameter sets the default share link role for Loop and Whiteboard files on OneDrive sites. - -The valid values are: - -- Edit -- View -- None -- Review -- RestrictedView +### -IsLoopEnabled +{{ Fill IsLoopEnabled Description }} ```yaml -Type: SharingRole +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2613,43 +2683,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreLoopDefaultSharingLinkScope +### -IsSharePointAddInsBlocked -This parameter sets the default share link scope for Loop and Whiteboard files on SharePoint sites. +When this feature is enabled, all functionalities of the add-ins will be restricted, preventing them from running or installing. -The valid values are: +The valid values are: -- Anyone -- Organization -- SpecificPeople -- Uninitialized +- False (default) - All the add-ins features are supported. +- True - All the add-ins features will be blocked. ```yaml -Type: SharingScope +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Uninitialized +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreLoopDefaultSharingLinkRole +### -IsSharePointAddInsDisabled -This parameter sets the default share link role for Loop and Whiteboard files on SharePoint sites. +When the feature is enabled, all the add-ins features will be disabled. -The valid values are: +The valid values are: -- Edit -- View -- None -- Review -- RestrictedView +- False (default) - All the add-ins features are supported. +- True - All the add-ins features will be disabled. ```yaml -Type: SharingRole +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2660,179 +2725,154 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. - -For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -### -ReduceTempTokenLifetimeEnabled -Enables reduced session timeout for temporary URLs used by apps for document download scenarios. Reduction occurs when an app redeeming an IP address does not match the original requesting IP. The default value is 15 minutes if ReduceTempTokenLifetimeValue is not set. +### -IsWBFluidEnabled -**Note**: Reducing this value may bring degradation in end-user experience by requiring frequent authentication prompts to users. +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. -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +The valid values are: -### -ReduceTempTokenLifetimeValue +- $true - Administrator enabled Whiteboard for user with OneDrive for Business Users. +- $false - Administrator disable Whiteboard for user with OneDrive for Business Users. -Optional parameter to set the session timeout value for temporary URLs. The value can be set between 5 and 15 minutes and the default value is 15 minutes. - ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: 15 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowPeoplePickerGroupSuggestionsForIB +### -LabelMismatchEmailHelpLink -The ShowPeoplePickerGroupSuggestionsForIB setting (defaulted to false) allows showing group suggestions for information barriers (IBs) in the People Picker. +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. -PARAMVALUE: True | False +The value can be any valid URL. ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InformationBarriersSuspension +### -LegacyAuthProtocolsEnabled -When InformationBarriersSuspension parameter is set to $false, information barriers in SharePoint and OneDrive is enabled, when set to $true, it is disabled. +By default this value is set to $True, which means that authentication using legacy protocols is enabled. -PARAMVALUE: True | False +Setting this parameter to $False prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. + +- True - Enables Office clients using non-modern authentication protocols (such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. +- False - Prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. + +> [!NOTE] +> • This may also prevent third-party apps from accessing SharePoint Online resources.
Also, this will also block apps using the SharePointOnlineCredentials class to access SharePoint Online resources. For additional information about SharePointOnlineCredentials, see SharePointOnlineCredentials class.

• The change is not instant. It might take up to 24 hours to be applied. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IBImplicitGroupBased - -The IBImplicitGroupBased setting enables Microsoft 365 Groups membership-based access and sharing control for all Implicit mode sites. - -PARAMVALUE: True | False +### -LegacyBrowserAuthProtocolsEnabled +{{ Fill LegacyBrowserAuthProtocolsEnabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultOneDriveInformationBarrierMode +### -LimitedAccessFileType + +Allows users to preview only Office files in the browser. This option increases security, but may be a barrier to user productivity. -The DefaultOneDriveInformationBarrierMode sets the information barrier mode for all OneDrive sites. +The following parameters can be used with `-ConditionalAccessPolicy AllowLimitedAccess` for both the organization-wide setting and the site-level setting. -The valid values are: +- OfficeOnlineFilesOnly: Allows users to preview only Office files in the browser. This option increases security but may be a barrier to user productivity. +- LimitedAccessFileType WebPreviewableFiles (default): Allows users to preview Office files in the browser. This option optimizes for user productivity but offers less security for files that aren't Office files. **Warning:** This option is known to cause problems with PDF and image file types because they can be required to be downloaded to the end user's machine to render in the browser. Plan the use of this control carefully. Otherwise, your users could be faced with unexpected "Access Denied" errors. +- LimitedAccessFileType OtherFiles: Allows users to download files that can't be previewed, such as .zip and .exe. This option offers less security. -- Open -- Explicit -- Implicit -- OwnerModerated -- Mixed +PARAMVALUE: OfficeOnlineFilesOnly | WebPreviewableFiles | OtherFiles -For more information about information barriers, see [Use information barriers with SharePoint](/purview/information-barriers-sharepoint) for your SharePoint Online environment. - ```yaml -Type: String -Parameter Sets: (All) +Type: Microsoft.Online.SharePoint.TenantManagement.SPOLimitedAccessFileType +Parameter Sets: ParamSetMultipleSites Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewersCanCommentOnMediaDisabled - -Controls whether viewers commenting on media items is disabled or not. - -PARAMVALUE: True | False +### -MajorVersionLimit +{{ Fill MajorVersionLimit Description }} ```yaml -Type: Boolean +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreSharingCapability +### -MarkNewFilesSensitiveByDefault -Determines what level of sharing is available for SharePoint sites (not including OneDrive sites). +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. -The valid values are: +Possible values are -- ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. -- Disabled - External user sharing (share by email) and guest link sharing are both disabled. -- ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. -- ExistingExternalUserSharingOnly - Only guests already in your organization's directory. +- BlockExternalSharing: Prevents guests from accessing newly added files until at least one Office DLP policy scans the content of the file. +- AllowExternalSharing: Disables this feature. -For more information about sharing, see [Manage sharing settings](/sharepoint/turn-external-sharing-on-or-off) for your SharePoint online environment. +For more information see [Mark new files as sensitive by default](/sharepoint/sensitive-by-default). ```yaml -Type: SharingCapabilities +Type: Microsoft.Online.SharePoint.TenantManagement.SensitiveByDefaultState Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: ExternalUserAndGuestSharing +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveRequestFilesLinkEnabled - -Enable or disable the Request files link on the OneDrive partition for all OneDrive sites. If this value is not set, the Request files link will only show for OneDrives with Anyone links enabled. - -PARAMVALUE: True | False +### -MassDeleteNotificationDisabled +{{ Fill MassDeleteNotificationDisabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -2840,14 +2880,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreRequestFilesLinkEnabled - -Enable or disable the Request files link on the core partition for all SharePoint sites (not including OneDrive sites). If this value is not set, Request files will only show for OneDrives with Anyone links enabled. +### -MaxCompatibilityLevel -PARAMVALUE: True | False +The only valid value is "15". ```yaml -Type: Boolean +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2858,62 +2896,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveRequestFilesLinkExpirationInDays - -Specifies the number of days before a Request files link expires for all OneDrive sites. +### -MediaTranscription -The value can be from 0 to 730 days. +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: -To remove the expiration requirement, set the value to zero (0). +- Enabled +- Disabled ```yaml -Type: Int32 +Type: Microsoft.Online.SharePoint.TenantManagement.MediaTranscriptionPolicyType Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: -1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreRequestFilesLinkExpirationInDays - -Specifies the number of days before a Request files link expires for all SharePoint sites (not including OneDrive sites). +### -MediaTranscriptionAutomaticFeatures -The value can be from 0 to 730 days. +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: -To remove the expiration requirement, set the value to zero (0). +- Enabled +- Disabled ```yaml -Type: Int32 +Type: Microsoft.Online.SharePoint.TenantManagement.MediaTranscriptionAutomaticFeaturesPolicyType Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: -1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousMeetingParticipantsToAccessWhiteboards - -When you share a whiteboard in a Teams meeting, Whiteboard creates a sharing link. This link is accessible by anyone within the organization. The whiteboard is also shared with any in-tenant users in the meeting. Whiteboards are shared using company-shareable links, regardless of the default setting. Support for the default sharing link type is planned. - -There's more capability for temporary collaboration by external and shared device accounts during a Teams meeting. Users can temporarily view and collaborate on whiteboards that are shared in a meeting, in a similar way to PowerPoint Live sharing. - -In this case, Whiteboard provides temporary viewing and collaboration on the whiteboard during the Teams meeting only. A share link isn't created and Whiteboard doesn't grant access to the file. - -If you have external sharing enabled for OneDrive for Business, no further action is required. +### -MinCompatibilityLevel -If you restrict external sharing for OneDrive for Business, you can keep it restricted, and just enable this new setting in order for external and shared device accounts to work. For more information, see [Manage sharing for Microsoft Whiteboard](/microsoft-365/whiteboard/manage-sharing-organizations). +The only valid value is "15". ```yaml -Type: SharingState +Type: System.Int32 Parameter Sets: (All) Aliases: +Applicable: SharePoint Online Required: False Position: Named Default value: None @@ -2921,12 +2952,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableBackToClassic +### -NoAccessRedirectUrl + +Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess." + +The valid values are: -Enables or disables the link "Return to classic SharePoint" on modern SharePoint list and library pages. +- "" (default) - Blank by default, this will also remove or clear any value that has been set. +- Full URL - Example: ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2937,16 +2973,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsEnableAppAuthPopUpEnabled - -Enables or disables users in the organization to authenticate SharePoint applications using popups. +### -NotificationsInOneDriveForBusinessEnabled -This parameter affects the way code in SharePoint interacts with Microsoft Entra ID to get tokens to access APIs. In scenarios where third-party cookies are disabled (such as Safari browsers with ITP feature enabled), any code that requires a token to access an API automatically triggers a full page refresh. When IsEnableAppAuthPopUpEnabled is set to $true, SharePoint will instead surface a popup in this scenario. +Enables or disables notifications in OneDrive for Business. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2957,22 +2991,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockDownloadFileTypePolicy - -You can block the download of Teams meeting recording files from SharePoint or OneDrive. This allows users to remain productive while addressing the risk of accidental data loss. Users have browser-only access to play the meeting recordings with no ability to download or sync files or access them through apps. - -This policy applies to new meeting recordings across the entire organization. You can exempt people who are members of specified security groups from the policy. This allows you to specify governance or compliance specialists who should have download access to meeting recordings. - -After the policy is turned on, any new Teams meeting recording files created by the Teams service and saved in SharePoint and OneDrive are blocked from download. - -Because this policy affects meeting recordings stored in OneDrive and SharePoint, you must be a SharePoint administrator to configure it. +### -NotificationsInSharePointEnabled -Note that this policy doesn't apply to manually uploaded meeting recording files. For more details, see [Block the download of Teams meeting recording files from SharePoint or OneDrive](/microsoftteams/block-download-meeting-recording). +Enables or disables notifications in SharePoint. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -2983,27 +3009,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAutoExpirationVersionTrim - -Global and SharePoint Administrators can set organization-level version history limits settings that universally apply to new versions created on all new document libraries created in your organization. +### -NotifyOwnersWhenInvitationsAccepted -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. +This parameter has been deprecated since SharePoint Online legacy invitation flow switched to Entra B2B invitation flow. -The valid values are: +### -NotifyOwnersWhenItemsReshared -- True – Version history limits for new versions created on all new document libraries in your organization will be managed automatically. -- False – Version history limits for new Versions created on all new document libraries in your organization will be managed manually by setting limits to the number of major versions (`MajorVersionLimit`) and time set (`ExpireVersionsAfterDays`). Review the documentation of both parameters to manage your organization's version limits manually. +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. -> [!NOTE] -> When version history limits are managed manually (`EnableAutoExpirationVersionTrim $false`), `MajorVersionLimit` and `ExpireVersionsAfterDays` are both required parameters with the following acceptable values: -> a. `MajorVersionLimit` accepts values from 1 through 50,000 (inclusive). -> b. `ExpireVersionsAfterDays` accepts values of 0 to Never Expire or values >= 30 to delete versions that exceed that time period. -> When version history limits are managed automatically (`EnableAutoExpirationVersionTrim $true`), setting `MajorVersionLimit` or `ExpireVersionsAfterDays` will result in an error as the count limits are set by the service. +For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. -PARAMVALUE: True | False +The valid values are $true and $false. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -3014,14 +3033,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MajorVersionLimit +### -ODBAccessRequests -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. +Lets administrators set policy on access requests and requests to share in OneDrive for Business. -PARAMVALUE: Int32 +The valid values are: + +- On - Users without permission to share can trigger sharing requests to the OneDrive for Business owner when they attempt to share. Also, users without permission to a file or folder can trigger access requests to the OneDrive for Business owner when they attempt to access an item they do not have permissions to. +- Off - Prevent access requests and requests to share on OneDrive for Business. +- Unspecified - Let each OneDrive for Business owner enable or disable access requests and requests to share on their OneDrive. ```yaml -Type: Int32 +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -3032,14 +3055,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExpireVersionsAfterDays +### -ODBMembersCanShare + +Lets administrators set policy on re-sharing behavior in OneDrive for Business. -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. +The valid values are: -PARAMVALUE: Int32 +- On - Users with edit permissions can re-share. +- Off - Only OneDrive for Business owner can share. The value of ODBAccessRequests defines whether a request to share gets sent to the owner. +- Unspecified - Let each OneDrive for Business owner enable or disable re-sharing behavior on their OneDrive. ```yaml -Type: Int32 +Type: Microsoft.SharePoint.Client.SharingState Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -3050,80 +3077,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MassDeleteNotificationDisabled - -Enables or disables the mass delete detection feature. When MassDeleteNotificationDisabled is set to $true, tenant admins can perform mass deletion operations without triggering notifications. - -PARAMVALUE: True | False +### -ODBMembersCanShare +{{ Fill ODBMembersCanShare Description }} ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Client.SharingState Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DelayDenyAddAndCustomizePagesEnforcementOnClassicPublishingSites +### -OfficeClientADALDisabled -This parameter controls how SharePoint will deal with classic publishing sites (templates BLANKINTERNETCONTAINER#0, CMSPUBLISHING#0 and BLANKINTERNET#0) where custom scripts are allowed. +When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. The valid values are: -* False (default) - for classic publishing site collections where administrators enabled the ability to add custom script, SharePoint will revoke that ability within 24 hours from the last time this setting was changed. -* True - All changes performed by administrators to custom script settings are preserved. - -> [!NOTE] -> This setting affects all classic publishing sites (templates BLANKINTERNETCONTAINER#0, CMSPUBLISHING#0 and BLANKINTERNET#0). There are no options to preserve changes to custom script settings only on some specific sites. +- False (default) - Modern Authentication is enabled/allowed. +- True - Modern Authentication via ADAL is disabled. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsDataAccessInCardDesignerEnabled - -The IsDataAccessInCardDesignerEnabled settings (defaulted to false) will allow Viva Connections Dashboard operators to access SharePoint and Graph APIs in the Card Designer card. - -The valid values are: - -- False (default) – SharePoint and Graph APIs cannot be accessed in the Card Designer card. -- True – Users with edit permissions on the Dashboard will be able to access SharePoint and Graph APIs in the Card Designer card. - -For more information on this feature, see [Overview of Viva Connections Card Designer advance API features](https://learn.microsoft.com/en-us/sharepoint/dev/spfx/viva/features/card-designer/card-designer-api-support). +### -OneDriveBlockGuestsAsSiteAdmin +{{ Fill OneDriveBlockGuestsAsSiteAdmin Description }} ```yaml -Type: Boolean +Type: Microsoft.SharePoint.Client.SharingState Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVersionExpirationSetting -The `EnableVersionExpirationSetting` parameter is no longer active, this feature is now automatically enabled for each tenant. -[Learn more about Version History Settings](/sharepoint/document-library-version-history-limits) +### -OneDriveDefaultLinkToExistingAccess +{{ Fill OneDriveDefaultLinkToExistingAccess Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3131,63 +3143,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveSharingCapability - -Determines what level of sharing is available for OneDrive sites. It corresponds to the `SharingCapabilities` for OneDrive sites. - -The valid values are: - -- ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. -- Disabled - External user sharing (share by email) and guest link sharing are both disabled. -- ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. -- ExistingExternalUserSharingOnly - Only guests already in your organization's directory. +### -OneDriveDefaultShareLinkRole +{{ Fill OneDriveDefaultShareLinkRole Description }} ```yaml -Type: SharingCapabilities +Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: ExternalUserAndGuestSharing +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -OneDriveDefaultShareLinkScope - -This parameter sets the default share link scope on OneDrive sites. It replaces the `DefaultSharingLinkType`. - -The valid values are: -- `Anyone`: Anyone with the link can access the content. -- `Organization`: Only people within the organization can access the content. -- `SpecificPeople`: Only specific individuals (specified by the user) can access the content. -- `Uninitialized`: The default value, indicating that the default share link scope is not explicitly set. +{{ Fill OneDriveDefaultShareLinkScope Description }} ```yaml -Type: SharingScope +Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: Uninitialized +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveDefaultShareLinkRole +### -OneDriveForGuestsEnabled -This parameter sets the default share link role on OneDrive sites. It replaces the `DefaultLinkPermission`. +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: -- `None`: No permissions granted. -- `View`: View-only permissions. -- `Edit`: Edit permissions. -- `Review`: Review permissions. -- `RestrictedView`: Restricted view permissions. + +- $true - Administrator managed Guest users can be given OneDrives, provided needed licenses are assigned. +- $false - Administrator managed Guest users can't be given OneDrives as functionality is turned off. ```yaml -Type: SharingRole +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3196,59 +3194,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveDefaultLinkToExistingAccess +### -OneDriveLoopDefaultSharingLinkRole -When set to `True`, the default sharing link will be a "People with Existing Access" link (which does not modify permissions) for OneDrive sites. When set to `False` (the default), the default sharing link type is controlled by the `OneDriveDefaultShareLinkScope` parameter. +This parameter sets the default share link role for Loop and Whiteboard files on OneDrive sites. -PARAMVALUE: True | False +The valid values are: + +- Edit +- View +- None +- Review +- RestrictedView ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SharingRole Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreDefaultShareLinkScope +### -OneDriveLoopDefaultSharingLinkScope -This parameter sets the default share link scope on SharePoint sites. It replaces the `DefaultSharingLinkType`. +Gets or sets default share link scope for Loop and Whiteboard files on OneDrive sites. The valid values are: -- `Anyone`: Anyone with the link can access the content. -- `Organization`: Only people within the organization can access the content. -- `SpecificPeople`: Only specific individuals (specified by the user) can access the content. -- `Uninitialized`: The default value, indicating that the default share link scope is not explicitly set. + +- Anyone +- Organization +- SpecificPeople +- Uninitialized ```yaml -Type: SharingScope +Type: Microsoft.SharePoint.Client.Sharing.SharingScope Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Uninitialized +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreDefaultShareLinkRole - -This parameter sets the default share link role on SharePoint sites. It replaces the `DefaultLinkPermission`. - -The valid values are: -- `None`: No permissions granted. -- `View`: View-only permissions. -- `Edit`: Edit permissions. -- `Review`: Review permissions. -- `RestrictedView`: Restricted view permissions. +### -OneDriveRequestFilesLinkEnabled +{{ Fill OneDriveRequestFilesLinkEnabled Description }} ```yaml -Type: SharingRole +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named Default value: None @@ -3256,129 +3256,107 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CoreDefaultLinkToExistingAccess - -When set to `True`, the default sharing link will be a "People with Existing Access" link (which does not modify permissions) for SharePoint sites. When set to `False` (the default), the default sharing link type is controlled by the `CoreDefaultShareLinkScope` parameter. - -PARAMVALUE: True | False +### -OneDriveRequestFilesLinkExpirationInDays +{{ Fill OneDriveRequestFilesLinkExpirationInDays Description }} ```yaml -Type: Boolean +Type: System.Int32 Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SelfServiceSiteCreationDisabled - -When set to `True`, users cannot create sites from SharePoint, OneDrive, the PnP PowerShell cmdlet, and the REST API. When set to `False` (the default), users can create sites from SharePoint, OneDrive, the PnP PowerShell cmdlet, and the REST API. - -PARAMVALUE: True | False +### -OneDriveSharingCapability +{{ Fill OneDriveSharingCapability Description }} ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SharingCapabilities Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncAadB2BManagementPolicy - -This feature allows SharePoint Online to synchronize several Entra B2B collaboration settings [Guest user access restriction and collaboration restriction](https://learn.microsoft.com/en-us/entra/external-id/external-collaboration-settings-configure#configure-settings-in-the-portal), and store them on SharePoint Online tenant store. On sharing, SharePoint checks whether those synchronized settings are blocking sharing before sending invitation requests to Entra B2B invitation manager. The sync might take up to 24 hours to complete if you change those Entra B2B collaboration settings. To make the change effective on SharePoint Online immediately, run 'Set-SPOTenant -SyncAadB2BManagementPolicy $true' and it forces a sync from Microsoft Entra. - -PARAMVALUE: True | False +### -OneDriveStorageQuota -```yaml -Type: Boolean -Parameter Sets: (All) -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. -### -ResyncContentSecurityPolicyConfigurationEntries +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. -When set to `True`, forces a sync of **Content Security Policy** sources for SharePoint Framework components in the tenant application catalog. -New sources will be added to the configuration, if not already present, based on the `cdnBasedPath` property under a solution's `.config/write-manifests.json` if present. -The sync may take up to 24 hours to complete. -In multi-geo environments, **Content Security Policy** configuration is unique to each geo. +If value is set to 0, the parameter will have no effect. -PARAMVALUE: True | False +If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect. ```yaml -Type: Boolean +Type: System.Int64 Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnforceContentSecurityPolicyConfiguration +### -OrphanedPersonalSitesRetentionPeriod -When set to `True` **Content Security Policy** violations will be enforced. -In multi-geo environments, **Content Security Policy** configuration is unique to each geo. +Specifies the number of days after a user's Active Directory account is deleted that their OneDrive for Business content will be deleted. -PARAMVALUE: True | False +The value range is in days, between 30 and 3650. The default value is 30. ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantAdministration.SyntexFeatureScopeValue Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnforceRequestDigest +### -OwnerAnonymousNotification -When set to `True` a valid request digest is required on SOAP API calls that perform a state-changing operation. +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 ```yaml -Type: Boolean +Type: System.String[] Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DocumentUnderstandingModelScope +### -PermissiveBrowserFileHandlingOverride -This parameter allows administrators to limit which SharePoint sites the document understanding model and [unstructurted document processesing](/microsoft-365/syntex/document-understanding-overview) premium feature is available on. +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: -- `NoSites`: Document understanding models are not available on any sites. -- `AllSites`: Document understanding models are available on all sites. -- `SelectedSites`: Document understanding models are available only on sites within the feature's selected sites list. - -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Use of this parameter will clear the current document understanding model selected sites list, if one exists. +- True - Enable the Permissive browser file handling setting. +- False - Keep the default Strict browser file handling setting. ```yaml -Type: SyntexFeatureScopeValue +Type: Microsoft.Online.SharePoint.TenantAdministration.SelectedSitesListOperations Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3387,16 +3365,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DocumentUnderstandingModelSelectedSitesList +### -PreventExternalUsersFromResharing -This parameter allows administrators to pass a list of SharePoint site URLs to modify the document understanding model and [unstructurted document processesing](/microsoft-365/syntex/document-understanding-overview) premium feature's selected sites list. By default this parameter overwrites the existing list with the user input list. Additionally, the `DocumentUnderstandingModelSelectedSitesListOperation` parameter can be used to specify a different operation. This parameter can only be called if the document understanding model's scope is set to `SelectedSites`. The inputted list of site URLs cannot exceed 100 items. +Prevents external users from resharing files, folders, and sites that they do not own. -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). +PARAMVALUE: True | False ```yaml -Type: String[] +Type: System.Int32 Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3405,48 +3383,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DocumentUnderstandingModelSelectedSitesListOperation +### -ProvisionSharedWithEveryoneFolder -This parameter allows administrators to specify the operation to perform on the document understanding model and [unstructurted document processesing](/microsoft-365/syntex/document-understanding-overview) premium feature's current selected sites list using the list of site URLs passed to the `DocumentUnderstandingModelSelectedSitesList` parameter. +Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. The valid values are: -- `Overwrite`: Overwrite the existing selected sites list. This is the default operation. -- `Append`: Append the input list of sites to the existing selected sites list. -- `Remove`: Remove the input list of sites from the existing selected sites list. +- True (default) - The Shared with Everyone folder is created. +- False - No folder is created when the site and OneDrive for Business document library is created. -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Calling this parameter without `DocumentUnderstandingModelSelectedSitesList` has no effect. +The default behavior of the Shared with Everyone folder changed in August 2015. ```yaml -Type: SelectedSitesListOperations +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Overwrite +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AIBuilderModelScope - -This parameter allows administrators to limit which SharePoint sites the AI builder model and [structured and freeform document processing](/microsoft-365/syntex/form-processing-overview) premium feature is available on. - -The valid values are: +### -PublicCdnAllowedFileTypes -- `NoSites`: AI builder models are not available on any sites. -- `AllSites`: AI builder models are available on all sites. -- `SelectedSites`: AI builder models are available only on sites within the feature's selected sites list. +Sets public CDN allowed file types, if the public CDN is enabled. -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Use of this parameter will clear the current AI builder model selected sites list, if one exists. +PARAMVALUE: String ```yaml -Type: SyntexFeatureScopeValue +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3455,16 +3424,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AIBuilderModelSelectedSitesList +### -PublicCdnEnabled -This parameter allows administrators to pass a list of SharePoint site URLs to modify the AI builder model and [structured and freeform document processing](/microsoft-365/syntex/form-processing-overview) premium feature's selected sites list. By default this parameter overwrites the existing list with the user input list. Additionally, the `AIBuilderModelSelectedSitesListOperation` parameter can be used to specify a different operation. This parameter can only be called if the AI builder model's scope is set to `SelectedSites`. The inputted list of site URLs cannot exceed 100 items. +Enables or disables the public CDN. -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). +PARAMVALUE: True | False ```yaml -Type: String[] +Type: Microsoft.Online.SharePoint.TenantAdministration.SyntexFeatureScopeValue Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3473,43 +3442,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AIBuilderModelSelectedSitesListOperation +### -RequireAcceptingAccountMatchInvitedAccount -This parameter allows administrators to specify the operation to perform on the AI builder model and [structured and freeform document processing](/microsoft-365/syntex/form-processing-overview) premium feature's current selected sites list using the list of site URLs passed to the `AIBuilderModelSelectedSitesList` parameter. +This parameter has been deprecated since SharePoint Online legacy invitation flow switched to Entra B2B invitation flow. -The valid values are: +### -RequireAnonymousLinksExpireInDays -- `Overwrite`: Overwrite the existing selected sites list. This is the default operation. -- `Append`: Append the input list of sites to the existing selected sites list. -- `Remove`: Remove the input list of sites from the existing selected sites list. +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. -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Calling this parameter without `AIBuilderModelSelectedSitesList` has no effect. +The value can be from 0 to 730 days. + +To remove the expiration requirement, set the value to zero (0). ```yaml -Type: SelectedSitesListOperations +Type: System.String[] Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Overwrite +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AIBuilderModelSelectedSitesIncludesContentCenters +### -RequireOrganizationLinksExpireInDays -This parameter allows administrators to choose whether or not the AI builder model and [structured and freeform document processing](/microsoft-365/syntex/form-processing-overview) premium feature is available on all content center sites when the feature's scope is `SelectedSites` even if they are not explicitly included within the selected sites list. This parameter can only be called if the AI builder model's scope is set to `SelectedSites`. +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. -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). +The value can be from 0 to 730 days. -PARAMVALUE: True | False +To remove the expiration requirement, set the value to zero (0). ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantAdministration.SelectedSitesListOperations Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3518,23 +3486,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrebuiltModelScope +### -ReSyncTenantPrivacyProfile -This parameter allows administrators to limit which SharePoint sites the prebuilt model and [prebuilt document processing](/microsoft-365/syntex/prebuilt-overview) premium feature is available on. +The 'SyncPrivacyProfileProperties' parameter is obsolete and renamed ReSyncTenantPrivacyProfile. -The valid values are: +This parameter enables the synchronization of privacy profile properties. -- `NoSites`: Prebuilt models are not available on any sites. -- `AllSites`: Prebuilt models are available on all sites. -- `SelectedSites`: Prebuilt models are available only on sites within the feature's selected sites list. +ReSyncTenantPrivacyProfile sets whether or not the synced tenant properties will be updated on the next request. The request will cause Microsoft Entra ID to grab the tenant's current display name (TenantDisplayName) and privacy profile URL (PrivacyProfileUrl). -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Use of this parameter will clear the current prebuilt model selected sites list, if one exists. +Running 'Set-SPOTenant - ReSyncTenantPrivacyProfile' will force a sync from the Microsoft Entra privacy profile URL to SharePoint Online. The sync may take up to 24 hours to complete. Whenever SharePoint Online gets the privacy profile URL, it checks whether the last sync time is out of the sync time window. If it is, it syncs from Microsoft Entra ID to SharePoint Online. ```yaml -Type: SyntexFeatureScopeValue +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3543,16 +3508,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrebuiltModelSelectedSitesList +### -SearchResolveExactEmailOrUPN + +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. -This parameter allows administrators to pass a list of SharePoint site URLs to modify the prebuilt model and [prebuilt document processing](/microsoft-365/syntex/prebuilt-overview) premium feature's selected sites list. By default this parameter overwrites the existing list with the user input list. Additionally, the `PrebuiltModelSelectedSitesListOperation` parameter can be used to specify a different operation. This parameter can only be called if the prebuilt model's scope is set to `SelectedSites`. The inputted list of site URLs cannot exceed 100 items. +SharePoint Administrators will still be able to use starts with or partial name matching when enabled. -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). +The valid values are: + +- False (default) - Starts with / partial name search functionality is available. +- True - Disables starts with for all users/partial name search functionality for all SharePoint users, except SharePoint Admins. ```yaml -Type: String[] +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3561,42 +3531,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrebuiltModelSelectedSitesListOperation - -This parameter allows administrators to specify the operation to perform on the prebuilt model and [prebuilt document processing](/microsoft-365/syntex/prebuilt-overview) premium feature's current selected sites list using the list of site URLs passed to the `PrebuiltModelSelectedSitesList` parameter. - -The valid values are: +### -SharingAllowedDomainList -- `Overwrite`: Overwrite the existing selected sites list. This is the default operation. -- `Append`: Append the input list of sites to the existing selected sites list. -- `Remove`: Remove the input list of sites from the existing selected sites list. +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". -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Calling this parameter without `PrebuiltModelSelectedSitesList` has no effect. +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). ```yaml -Type: SelectedSitesListOperations +Type: System.String Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Overwrite +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultContentCenterSite +### -SharingBlockedDomainList -This parameter allows administrators to set the default content center site for their tenant, if one does not already exist, by providing a content center's URL. The content center configured here is the default for all document processing services. Content center owners can view analytics for all applied models in it, and members can build enterprise models. For more information visit [Create a content center in Microsoft Syntex](/microsoft-365/syntex/create-a-content-center). +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". -> [!NOTE] -> Use of this parameter requires that the tenant either have the required license or pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> You cannot change the designated default content center once it has been set. +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). ```yaml -Type: String +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -3605,24 +3567,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DocumentTranslationScope - -This parameter allows administrators to limit which SharePoint sites the [document translation](/microsoft-365/syntex/translation) premium feature is available on. - -The valid values are: - -- `NoSites`: Document translation is not available on any sites. -- `AllSites`: Document translation is available on all sites. -- `SelectedSites`: Document translation is available only on sites within the feature's selected sites list. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Use of this parameter will clear the current document translation selected sites list, if one exists. +### -RecycleBinRetentionPeriod +{{ Fill RecycleBinRetentionPeriod Description }} ```yaml -Type: SyntexFeatureScopeValue +Type: System.Int32 Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named Default value: None @@ -3630,17 +3582,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DocumentTranslationSelectedSitesList - -This parameter allows administrators to pass a list of SharePoint site URLs to modify the [document translation](/microsoft-365/syntex/translation) premium feature's selected sites list. By default this parameter overwrites the existing list with the user input list. Additionally, the `DocumentTranslationSelectedSitesListOperation` parameter can be used to specify a different operation. This parameter can only be called if document translation's scope is set to `SelectedSites`. The inputted list of site URLs cannot exceed 100 items. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). +### -ReduceTempTokenLifetimeEnabled +{{ Fill ReduceTempTokenLifetimeEnabled Description }} ```yaml -Type: String[] +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named Default value: None @@ -3648,49 +3597,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DocumentTranslationSelectedSitesListOperation - -This parameter allows administrators to specify the operation to perform on the [document translation](/microsoft-365/syntex/translation) premium feature's current selected sites list using the list of site URLs passed to the `DocumentTranslationSelectedSitesList` parameter. - -The valid values are: - -- `Overwrite`: Overwrite the existing selected sites list. This is the default operation. -- `Append`: Append the input list of sites to the existing selected sites list. -- `Remove`: Remove the input list of sites from the existing selected sites list. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Calling this parameter without `DocumentTranslationSelectedSitesList` has no effect. +### -ReduceTempTokenLifetimeValue +{{ Fill ReduceTempTokenLifetimeValue Description }} ```yaml -Type: SelectedSitesListOperations +Type: System.Int32 Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: Overwrite +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AutofillColumnsScope +### -RequireAcceptingAccountMatchInvitedAccount +Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. -This parameter allows administrators to limit which SharePoint sites the [autofill columns](/microsoft-365/syntex/autofill-overview) premium feature is available on. +The parameter accepts two values: True or False. -The valid values are: +True-User must accept this invitation with bob@contoso.com. -- `NoSites`: Autofill columns are not available on any sites. -- `AllSites`: Autofill columns are available on all sites. -- `SelectedSites`: Autofill columns are available only on sites within the feature's selected sites list. +False- When a document is shared with an external user, bob@contoso.com, it can be accepted by any user with access to the invitation link in the original e-mail. -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Use of this parameter will clear the current autofill columns selected sites list, if one exists. +Administrators who desire increased control over external collaborators should consider enabling this feature. + +This only applies to new external users accepting new sharing invitations. + +The resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. ```yaml -Type: SyntexFeatureScopeValue +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named Default value: None @@ -3698,17 +3639,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutofillColumnsSelectedSitesList - -This parameter allows administrators to pass a list of SharePoint site URLs to modify the [autofill columns](/microsoft-365/syntex/autofill-overview) premium feature's selected sites list. By default this parameter overwrites the existing list with the user input list. Additionally, the `AutofillColumnsSelectedSitesListOperation` parameter can be used to specify a different operation. This parameter can only be called if autofill columns' scope is set to `SelectedSites`. The inputted list of site URLs cannot exceed 100 items. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). +### -RequireAnonymousLinksExpireInDays +{{ Fill RequireAnonymousLinksExpireInDays Description }} ```yaml -Type: String[] +Type: System.Int32 Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named Default value: None @@ -3716,49 +3654,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutofillColumnsSelectedSitesListOperation - -This parameter allows administrators to specify the operation to perform on the [autofill columns](/microsoft-365/syntex/autofill-overview) premium feature's current selected sites list using the list of site URLs passed to the `AutofillColumnsSelectedSitesList` parameter. - -The valid values are: - -- `Overwrite`: Overwrite the existing selected sites list. This is the default operation. -- `Append`: Append the input list of sites to the existing selected sites list. -- `Remove`: Remove the input list of sites from the existing selected sites list. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Calling this parameter without `AutofillColumnsSelectedSitesList` has no effect. +### -RestrictedAccessControlForOneDriveErrorHelpLink +{{ Fill RestrictedAccessControlForOneDriveErrorHelpLink Description }} ```yaml -Type: SelectedSitesListOperations +Type: System.String Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: Overwrite +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OpticalCharacterRecognitionScope - -This parameter allows administrators to limit which SharePoint sites the [optical character recognition](/microsoft-365/syntex/ocr) premium feature is available on. - -The valid values are: - -- `NoSites`: Optical character recognition is not available on any sites. -- `AllSites`: Optical character recognition is available on all sites. -- `SelectedSites`: Optical character recognition is available only on sites within the feature's selected sites list. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Use of this parameter will clear the current optical character recognition selected sites list, if one exists. +### -RestrictedAccessControlforSitesErrorHelpLink +{{ Fill RestrictedAccessControlforSitesErrorHelpLink Description }} ```yaml -Type: SyntexFeatureScopeValue +Type: System.String Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named Default value: None @@ -3766,17 +3684,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OpticalCharacterRecognitionSelectedSitesList - -This parameter allows administrators to pass a list of SharePoint site URLs to modify the [optical character recognition](/microsoft-365/syntex/ocr) premium feature's selected sites list. By default this parameter overwrites the existing list with the user input list. Additionally, the `OpticalCharacterRecognitionSelectedSitesListOperation` parameter can be used to specify a different operation. This parameter can only be called if optical character recognition's scope is set to `SelectedSites`. The inputted list of site URLs cannot exceed 100 items. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). +### -ResyncContentSecurityPolicyConfigurationEntries +{{ Fill ResyncContentSecurityPolicyConfigurationEntries Description }} ```yaml -Type: String[] +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named Default value: None @@ -3784,148 +3699,94 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OpticalCharacterRecognitionSelectedSitesListOperation - -This parameter allows administrators to specify the operation to perform on the [optical character recognition](/microsoft-365/syntex/ocr) premium feature's current selected sites list using the list of site URLs passed to the `OpticalCharacterRecognitionSelectedSitesList` parameter. - -The valid values are: - -- `Overwrite`: Overwrite the existing selected sites list. This is the default operation. -- `Append`: Append the input list of sites to the existing selected sites list. -- `Remove`: Remove the input list of sites from the existing selected sites list. - -> [!NOTE] -> Use of this parameter requires that the tenant has pay-as-you-go billing set up. For more information, visit [Licensing for Microsoft Syntex](/microsoft-365/syntex/syntex-licensing). -> Calling this parameter without `OpticalCharacterRecognitionSelectedSitesList` has no effect. +### -ReSyncTenantPrivacyProfile +{{ Fill ReSyncTenantPrivacyProfile Description }} ```yaml -Type: SelectedSitesListOperations +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: Overwrite +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled -Enables or disables web property bag updates in all sites in the tenant. When `AllowWebPropertyBagUpdateWhenDenyAddAndCustomizePagesIsEnabled` is set to `$true`, the web property bag can be updated even if the Add And Customize Pages right is denied on a site collection. -PARAMVALUE: True | False +### -SearchResolveExactEmailOrUPN +Removes the search capability from People Picker. + +The valid values are: + +* Recently resolved names will still appear in the list. +* False- Restores default search functionality. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhoCanShareAnonymousAllowList - -Sets the list of security groups who are allowed to share with anonymous (non-authenticated) users as well as authenticated guest users. Each security group is denoted by its GUID object ID in the Entra directory. - -> [!NOTE] -> This allow list only accepts security groups, and not Microsoft 365 Groups. - -To set this list to be a specific security group, you need to enter its GUID as the argument. You can enter multiple GUIDs by using commas to separate them. To view the current list, use [./Get-SPOTenant.md](Get-SPOTenant.md). - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhoCanShareAuthenticatedGuestAllowList - -Sets the list of security groups who are only allowed to share with authenticated guest users. Each security group is denoted by its GUID object ID. - -> [!NOTE] -> This allow list only accepts security groups, and not Microsoft 365 Groups. - -To set this list to be a specific security group, you need to enter its GUID as the argument. You can enter multiple GUIDs by using commas to separate them. To view the current list, use [./Get-SPOTenant.md](Get-SPOTenant.md). - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendPermissionsToUnprotectedFiles - -This property can be used to turn on/off the capability called "Extended SharePoint permissions to unprotected files". To learn more about this feature check [here](https://aka.ms/ExtendSharePointPermission) - -PARAMVALUE: True | False +### -SelfServiceSiteCreationDisabled +{{ Fill SelfServiceSiteCreationDisabled Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LegacyBrowserAuthProtocolsEnabled - -Controls whether legacy browser authentication connections to SharePoint with legacy Relying Party suite (RPS) protocol are enabled. Legacy protocols are more susceptible to brute-force and phishing attacks because they use non-modern authentication methods. Setting this to False prevents applications, (including third party applications) from using non-modern authentication protocols to access SharePoint Online and OneDrive resources in a browser. - -PARAMVALUE: True | False +### -SensitivityLabel +{{ Fill SensitivityLabel Description }} ```yaml -Type: Boolean -Parameter Sets: (All) -Applicable: SharePoint Online +Type: System.String +Parameter Sets: ParamSetMultipleSites +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDiscoverableByOrganizationForVideos - -When set to true, allows users to easily share a video with the entire company, using the security group defined in "AllOrganizationSecurityGroupId". If this security group is undefined, the Discoverable By Company for Videos feature will remain hidden. - -PARAMVALUE: True | False +### -SharingAllowedDomainList +{{ Fill SharingAllowedDomainList Description }} ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RestrictedAccessControlforSitesErrorHelpLink - -Sets a custom learn more link to inform users who were denied access to a SharePoint site due to the restricted site access control policy. +### -SharingBlockedDomainList +{{ Fill SharingBlockedDomainList Description }} ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -3933,12 +3794,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SensitivityLabel +### -SharingCapability + +Determines what level of sharing is available for OneDrive and SharePoint sites. + +The valid values are: + +- ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled. +- Disabled - External user sharing (share by email) and guest link sharing are both disabled. +- ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled. +- ExistingExternalUserSharingOnly - Only guests already in your organization's directory. -Sets the sensitiviy label for a site. +For more information about sharing, see [Manage sharing settings](/sharepoint/turn-external-sharing-on-or-off) for your SharePoint online environment. ```yaml -Type: String +Type: Microsoft.Online.SharePoint.TenantManagement.SharingCapabilities Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -3949,72 +3819,92 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableWorkflow2010 +### -SharingDomainRestrictionMode -Controls whether Workflow 2010 is enabled. +Specifies the external sharing mode for domains. -PARAMVALUE: True | False +The valid values are: + +- None +- AllowList - Users will be able to share with external collaborators coming only from that email domain. +- BlockList - Users will be able to share with all external collaborators apart from the ones on the BlockedDomainList. + +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). ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SharingDomainRestrictionModes Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Sites +### -ShowAllUsersClaim + +Enables the administrator to hide the All Users claim groups in People Picker. -List of sites that certain properties will apply to, such as a conditional access policy. +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. + +Note, the All Users (authenticated) group is equivalent to the Everyone claim, and shows as Everyone. +To change this, see -ShowEveryoneClaim. -The valid values are: +The valid values are: -- Url -- SiteId +- True (default) - The All Users claim groups are displayed in People Picker. +- False - The All Users claim groups are hidden in People Picker. ```yaml -Type: SpoSitePipeBind +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: Uninitialized +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AnyoneLinkTrackUsers +### -ShowEveryoneClaim -Requires recipients to verify their identity with an email address to access content from an Anyone link. +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. -PARAMVALUE: True | False +Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. + +The valid values are: + +- True - The Everyone claim group is displayed in People Picker. This has been the default for tenants older than March 2018 +- False (default) - The Everyone claim group is hidden from the People Picker. This has become the new default for new tenants. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveBlockGuestsAsSiteAdmin +### -ShowEveryoneExceptExternalUsersClaim -Controls whether guests are blocked from using OneDrive. +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. The valid values are: -- On -- Off -- Unspecified +- True (default) - The Everyone except external users is displayed in People Picker. +- False - The Everyone except external users claim is not visible in People Picker. ```yaml -Type: SharingState +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -4025,184 +3915,173 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharingOutsideRestrictedAccessControlGroups - -Controls whether sharing SharePoint sites and their content is allowed with users and groups who are not allowed as per the Restricted access control policy. - -PARAMVALUE: True | False +### -ShowOpenInDesktopOptionForSyncedFiles +{{ Fill ShowOpenInDesktopOptionForSyncedFiles Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Workflows2013Enabled - -Controls whether Workflow 2013 is enabled. - -PARAMVALUE: True | False +### -ShowPeoplePickerGroupSuggestionsForIB +{{ Fill ShowPeoplePickerGroupSuggestionsForIB Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsCollabMeetingNotesFluidEnabled +### -ShowPeoplePickerSuggestionsForGuestUsers -Controls whether collaborative meeting notes are enabled in Microsoft Teams. +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 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsLoopEnabled +### -SignInAccelerationDomain + +Specifies the home realm discovery value to be sent to Microsoft Entra ID during the user sign-in process. -Controls whether Loop components are available in Microsoft Teams. +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. +This value can also be used with Microsoft Entra ID P1 or P2 to customize the Microsoft Entra sign-in page. -PARAMVALUE: True | False +Acceleration will not occur on site collections that are shared externally. + +This value should be configured with the login domain that is used by your company (that is, example@contoso.com). + +If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. + +The valid values are: + +- "" (default) - Blank by default, this will also remove or clear any value that has been set. +- Login Domain - For example: "contoso.com" ```yaml -Type: Boolean +Type: System.String Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisablePersonalListCreation +### -SiteOwnerManageLegacyServicePrincipalEnabled -Controls whether users can create a personal list. +Allows or disallows the site collection admins to manage the Azure Access Control (ACS) service principal. -PARAMVALUE: True | False +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. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableVivaConnectionsAnalytics - -Controls whether the Viva Connections analytics feature is enabled. - -PARAMVALUE: True | False +### -Sites +{{ Fill Sites Description }} ```yaml -Type: Boolean -Parameter Sets: (All) -Applicable: SharePoint Online +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind[] +Parameter Sets: ParamSetMultipleSites +Aliases: + Required: False Position: Named -Default value: False -Accept pipeline input: False +Default value: None +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -AppBypassInformationBarriers +### -SocialBarOnSitePagesDisabled + +Disables or enables the Social Bar. -Controls whether applications running in app-only mode can access sites protected by information barriers. +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. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableModernListTemplateIds - -Specifies list of modern template IDs not enabled in tenant. - -To set this list to be a specific security group, you need to enter its GUID as the argument. You can enter multiple GUIDs by using commas to separate them. To view the current list, use [./Get-SPOTenant.md](Get-SPOTenant.md). - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableModernListTemplateIds - -Specifies list of modern template IDs enabled in tenant. - -To set this list to be a specific security group, you need to enter its GUID as the argument. You can enter multiple GUIDs by using commas to separate them. To view the current list, use [./Get-SPOTenant.md](Get-SPOTenant.md). +### -SpecialCharactersStateInFileFolderNames -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Permits the use of special characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. -### -HideSyncButtonOnTeamSite +> [!NOTE] +> The only two characters that can be managed at this time are the # and % characters. -When set to true, turns off OneDrive sync from all the SharePoint libraries in your organization. +The valid values are: -PARAMVALUE: True | False +- NoPreference - Support for feature will be enabled by Microsoft on your Office 365 tenant. +- Allowed - Lets the # and % characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. +- Disallowed - Disallows the # and % characters in file and folder names in SharePoint Online and OneDrive for Business document libraries. ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SpecialCharactersState Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StreamLaunchConfig +### -StartASiteFormUrl + +Specifies URL of the form to load in the Start a Site dialog. + +The valid values are: -Sets the default destination for the Stream app launcher tile. +- "" (default) - Blank by default, this will also remove or clear any value that has been set. +- Full URL - Example: " ```yaml -Type: Int32 +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -4213,70 +4092,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRestrictedAccessControl +### -StopNew2010Workflows -Lets you and other Global or SharePoint Administrators restrict access to sites. +Prevents creation of new SharePoint 2010 classic workflows. PARAMVALUE: True | False ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockDownloadFileTypeIds - -Specifies the list of file type IDs that BlockDownloadFileTypePolicy applies to. - +### -StopNew2013Workflows -The valid values are: +Prevents creation of new SharePoint 2013 classic workflows. -- TeamsMeetingRecording +PARAMVALUE: True | False ```yaml -Type: SPBlockDownloadFileTypeId[] +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedBlockDownloadGroupIds - -Exempts users from specified groups from the block download policy and they can fully download any content for the site. - -To set this list to be a specific security group, you need to enter its GUID as the argument. You can enter multiple GUIDs by using commas to separate them. To view the current list, use [./Get-SPOTenant.md](Get-SPOTenant.md). - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecycleBinRetentionPeriod - -Sets the amount of time content is kept in the in recycle bin in Microsoft365.com before it is deleted. +### -StreamLaunchConfig +{{ Fill StreamLaunchConfig Description }} ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4284,80 +4141,90 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaReactions - -Controls whether media reactions are enabled. - -PARAMVALUE: True | False +### -SyncAadB2BManagementPolicy +{{ Fill SyncAadB2BManagementPolicy Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSensitivityLabelOnRecords - -Controls whether sensitivity labels can be applied to records. - -PARAMVALUE: True | False +### -SyncPrivacyProfileProperties +{{ Fill SyncPrivacyProfileProperties Description }} ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ContentSecurityPolicyEnforcement - -Controls whether content security policy is enabled. - -PARAMVALUE: True | False +### -TlsTokenBindingPolicyValue +{{ Fill TlsTokenBindingPolicyValue Description }} ```yaml -Type: Boolean +Type: Microsoft.Online.SharePoint.TenantManagement.SPOTlsTokenBindingPolicyValue Parameter Sets: (All) -Applicable: SharePoint Online +Aliases: + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableSpacesActivation +### -UseFindPeopleInPeoplePicker -Controls SharePoint spaces activation. +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 +> [!NOTE] +> When set to $true, users aren't able to share with security groups or SharePoint groups. + ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UsePersistentCookiesForExplorerView +> [!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. + +Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. -### -AllowSelectSecurityGroupsInSPSitesList +"Open with Explorer" requires persisted cookies to operate correctly. +When the user does not select "Keep Me Signed in" at the time of sign-in, "Open with Explorer" will fail. + +This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online. +To clear this cookie, the user must log out of their Windows session. + +The valid values are: -Allows members of specific security groups to access SharePoint content. +- False (default) - No special cookie is generated and the normal Office 365 sign-in length/timing applies. +- True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign-in. ```yaml -Type: String[] +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -4368,15 +4235,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DenySelectSecurityGroupsInSPSitesList - -Restricts members of specific security groups from accessing SharePoint content. +### -ViewersCanCommentOnMediaDisabled +{{ Fill ViewersCanCommentOnMediaDisabled Description }} ```yaml -Type: String[] +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4384,15 +4250,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSelectSGsInODBListInTenant +### -ViewInFileExplorerEnabled + +Enables or disables the ability to use View in Explorer in Microsoft Edge (93) or above. + +> [!NOTE] +> When the value is set the View In Explorer command will become visible in UX for all users using Edge browser version 93 or above however those users still need [ConfigureViewInFileExplorer](/deployedge/microsoft-edge-policies#configureviewinfileexplorer) Edge policy enabled for the functionality to work. +> +> Minimum Module Version Required: 16.0.21610.12000 + +The valid values are: -Allows members of specific security groups to access OneDrive content. +- False (default) - Disables View In Explorer command to become visible in Edge. +- True - Enables View In Explorer command to become visible in Edge. ```yaml -Type: String[] +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online Required: False Position: Named Default value: None @@ -4400,15 +4275,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DenySelectSGsInODBListInTenant - -Restricts members of specific security groups from accessing OneDrive content. +### -WhoCanShareAnonymousAllowList +{{ Fill WhoCanShareAnonymousAllowList Description }} ```yaml -Type: String[] +Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4416,17 +4290,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExemptNativeUsersFromTenantLevelRestricedAccessControl - -Gets or sets the value of a setting which determines whether Native Identity users should be exempted from restricted access control policy at tenant level. - -PARAMVALUE: True | False +### -WhoCanShareAuthenticatedGuestAllowList +{{ Fill WhoCanShareAuthenticatedGuestAllowList Description }} ```yaml -Type: Boolean +Type: System.Guid[] Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4434,16 +4305,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppAccessInformationBarriersAllowList - -Gets or sets the list of third-party application IDs (GUIDs) that are allowed to access information barriers protected sites and OneDrive accounts in the tenant. -Note: The feature associated with this cmdlet will be rolling out soon. +### -Workflows2013Enabled +{{ Fill Workflows2013Enabled Description }} ```yaml -Type: String[] +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -4451,6 +4320,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES ## RELATED LINKS @@ -4459,3 +4336,5 @@ Accept wildcard characters: False [Get-SPOSite](Get-SPOSite.md) [Set-SPOSite](Set-SPOSite.md) + +[Upgrade-SPOSite](Upgrade-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnEnabled.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnEnabled.md index 88a9da980..9c0d15518 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnEnabled.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenantcdnenabled applicable: SharePoint Online @@ -18,9 +18,9 @@ Enables or disables Public content delivery network (CDN) or Private CDN on the ## SYNTAX -```powershell -Set-SPOTenantCdnEnabled [-CdnType ] [-Confirm] [-Enable ] [-NoDefaultOrigins] - [-WhatIf] [] +``` +Set-SPOTenantCdnEnabled [-Enable ] [-CdnType ] [-NoDefaultOrigins] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,7 +29,7 @@ Enables or disables Public content delivery network (CDN) or Private CDN on the ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Set-SPOTenantCdnEnabled -CdnType public -Enable $true @@ -44,7 +44,7 @@ The example enables a CDN. Specifies the CDN type. The valid values are: public or private. ```yaml -Type: SPOTenantCdnTypeClient +Type: Microsoft.Online.SharePoint.PowerShell.SPOTenantCdnTypeClient Parameter Sets: (All) Aliases: Accepted values: Public, Private, Both @@ -56,14 +56,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Enable -Prompts you for confirmation before running the cmdlet. +Specifies if the CDN is enabled. + +The valid values are: $True and $False. ```yaml -Type: SwitchParameter +Type: System.Boolean Parameter Sets: (All) -Aliases: cf +Aliases: Applicable: SharePoint Online Required: False Position: Named @@ -72,14 +74,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enable - -Specifies if the CDN is enabled. +### -NoDefaultOrigins -The valid values are: $True and $False. +PARAMVALUE: SwitchParameter ```yaml -Type: Boolean +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -90,14 +90,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NoDefaultOrigins +### -Confirm -PARAMVALUE: SwitchParameter +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online Required: False Position: Named @@ -112,7 +112,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi Applicable: SharePoint Online @@ -139,7 +139,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnPolicy.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnPolicy.md index ef8e20e87..ee9a0dc68 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantCdnPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenantcdnpolicy applicable: SharePoint Online @@ -18,8 +18,9 @@ Sets the content delivery network (CDN) policies at the tenant level. ## SYNTAX -```powershell -Set-SPOTenantCdnPolicy -CdnType -PolicyType -PolicyValue [] +``` +Set-SPOTenantCdnPolicy -PolicyType -PolicyValue -CdnType + [] ``` ## DESCRIPTION @@ -28,7 +29,7 @@ Use this cmdlet to set the content delivery network (CDN) policies at the tenant ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SPOTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,BMP" @@ -36,7 +37,7 @@ Set-SPOTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -Policy This example sets a CDN to a public type with a policy value of listed extensions. -### --------------------EXAMPLE 2--------------------- +### EXAMPLE 2 ```powershell Set-SPOTenantCdnPolicy -CdnType Public -PolicyType ExcludeRestrictedSiteClassifications -PolicyValue "Confidential,Restricted" @@ -51,7 +52,7 @@ This example sets the ExcludeRestrictedSiteClassifications policy for the select The CdnType parameter specifies the CDN type. The valid values are Public or Private. ```yaml -Type: SPOTenantCdnType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnType Parameter Sets: (All) Aliases: Accepted values: Public, Private @@ -74,10 +75,10 @@ Valid values: - ExcludeIfNoScriptDisabled ```yaml -Type: SPOTenantCdnPolicyType +Type: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantCdnPolicyType Parameter Sets: (All) Aliases: -Accepted values: IncludeFileExtensions, ExcludeRestrictedSiteClassifications, ExcludeIfNoScriptDisabled +Accepted values: IncludeFileExtensions, ExcludeRestrictedSiteClassifications, ExcludeIfNoScriptDisabled, ExcludeRestrictedSiteClassificationsFileExtensions Applicable: SharePoint Online Required: True Position: Named @@ -91,7 +92,7 @@ Accept wildcard characters: False A String representing the value of the policy type defined by the PolicyType parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantContentTypeReplicationParameters.md similarity index 92% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantContentTypeReplicationParameters.md index ce434adf2..8f51b442e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantContentTypeReplicationParameters.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenantcontenttypereplicationparameters applicable: SharePoint Online @@ -18,18 +18,16 @@ Select content types for replication ## SYNTAX -### ReplicateAllContentTypes - -```powershell -Set-SPOTenantContentTypeReplicationParameters [-ReplicateAllContentTypes] [] +### ReplicateSelectedContentTypes (Default) ``` - -### ReplicateSelectedContentTypes - -```powershell Set-SPOTenantContentTypeReplicationParameters -ReplicatedContentTypes [] ``` +### ReplicateAllContentTypes +``` +Set-SPOTenantContentTypeReplicationParameters [-ReplicateAllContentTypes] [] +``` + ## DESCRIPTION Before you run the cmdlets, please use 'Connect-SPOService' to connect to SharePoint Online first. @@ -60,7 +58,7 @@ Tenant admin can also reset to replicate all the content types. The ReplicateAllContentTypes parameter specifies whether all content types should be replicated. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ReplicateAllContentTypes Aliases: Applicable: SharePoint Online @@ -76,7 +74,7 @@ Accept wildcard characters: False Specifies a comma separated list of content types that should be replicated. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ReplicateSelectedContentTypes Aliases: Applicable: SharePoint Online @@ -91,6 +89,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantPreAuthSettings.md similarity index 92% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantPreAuthSettings.md index 594034549..9df7189da 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantPreAuthSettings.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantPreAuthSettings.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenantpreauthsettings applicable: SharePoint Online @@ -20,24 +20,24 @@ Sets the configuration of pre-authentication. ## SYNTAX ### IsDisabled -```powershell +``` Set-SPOTenantPreAuthSettings -IsDisabled [] ``` ### AddListItem -```powershell +``` Set-SPOTenantPreAuthSettings [-Add] -Type [-IncludedApps ] [-ExcludedApps ] [-IncludedFeatures ] [-ExcludedFeatures ] [] ``` ### RemoveListItem -```powershell +``` Set-SPOTenantPreAuthSettings [-Remove] -Id [] ``` ## DESCRIPTION -You can use this cmdlet to configure or disable the pre-authentication feature within SharePoint Online. The disablement can be combined with switches to support granular pre-authentication management for specific apps and features at the tenant level. +You can use this cmdlet to configure or disable the pre-authentication feature within SharePoint Online. The disablement can be combined with switches to support granular pre-authentication management for specific apps and features at the tenant level. > [!NOTE] > **What is pre-authentication?** @@ -49,20 +49,20 @@ You can use this cmdlet to configure or disable the pre-authentication feature w > But this feature is currently being deprecated, so this cmdlet lets you control the use of pre-authentication in various use cases. > [!IMPORTANT] -> The settings leverage an order of precedence: +> The settings leverage an order of precedence: > 1. Deny > 2. Allow > 3. IsDisabled > -> Additionally, as the use of this cmdlet can disable functionality in your SharePoint Online tenant, it is _highly recommended_ to test and evaluate each change in a test tenant ahead of making changes in a production environment. +> Additionally, as the use of this cmdlet can disable functionality in your SharePoint Online tenant, it is _highly recommended_ to test and evaluate each change in a test tenant ahead of making changes in a production environment. -You must be a SharePoint Administrator to run the cmdlet. +You must be a SharePoint Administrator to run the cmdlet. ## EXAMPLES ### Example 1 ```powershell -Set-SPOTenantPreAuthSettings -IsDisabled $true +Set-SPOTenantPreAuthSettings -IsDisabled $true Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" ``` @@ -74,7 +74,7 @@ Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b- ``` This example performs the same function as example 1 except in this case the switches for `-ExcludedApps`, `-IncludedFeatures`, and `-ExcludedFeatures` are added to the cmdlet. -These switches are assumed to take the default value of `""` if not used with the cmdlet and example 2 is used to demonstrate the complete set of switches only. +These switches are assumed to take the default value of `""` if not used with the cmdlet and example 2 is used to demonstrate the complete set of switches only. ### Example 3 ```powershell @@ -84,13 +84,13 @@ This example will remove an existing item from the current list of items. The re ### Example 4 ```powershell -Set-SPOTenantPreAuthSettings -IsDisabled $true +Set-SPOTenantPreAuthSettings -IsDisabled $true -Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed" +Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed" ``` -This example disables pre-authentication overall and allows all apps apart from one to use pre-authentication for all features except for `"Download"` and `"WebRenderingEmbed"`. +This example disables pre-authentication overall and allows all apps apart from one to use pre-authentication for all features except for `"Download"` and `"WebRenderingEmbed"`. -In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` will always be denied from using pre-authentication since it is excluded from the allow list setting. Any other app will be allowed to use pre-authentication for any feature apart from `"Download"` and `"WebRenderingEmbed"`. +In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` will always be denied from using pre-authentication since it is excluded from the allow list setting. Any other app will be allowed to use pre-authentication for any feature apart from `"Download"` and `"WebRenderingEmbed"`. ### Example 5 ```powershell @@ -100,9 +100,9 @@ Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b- Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" ``` -This example disables pre-authentication overall but contains an overlap between the settings in the Allow list and Deny list. It first allows an app to use pre-authentication for the `"OfficeOnline"`, `"WebRenderingEmbed"`, and `"Download"` features. But in the final execution of the cmdlet, it denies the same app from using pre-authentication for all features. +This example disables pre-authentication overall but contains an overlap between the settings in the Allow list and Deny list. It first allows an app to use pre-authentication for the `"OfficeOnline"`, `"WebRenderingEmbed"`, and `"Download"` features. But in the final execution of the cmdlet, it denies the same app from using pre-authentication for all features. -In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` would not be allowed to use pre-authentication for any of the allow-listed features despite having the setting. This is because the Deny list takes precedence over the Allow list. +In this case, the app `"029e7c27-4b9c-4f8b-ba32-b96249468d42"` would not be allowed to use pre-authentication for any of the allow-listed features despite having the setting. This is because the Deny list takes precedence over the Allow list. ### Example 6 ```powershell @@ -110,7 +110,7 @@ Set-SPOTenantPreAuthSettings -IsDisabled $false Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty" ``` -This example enables pre-authentication overall and denies requests that are not coming from an app (e.g. requests coming via a browser) from using pre-authentication for all features. +This example enables pre-authentication overall and denies requests that are not coming from an app (e.g. requests coming via a browser) from using pre-authentication for all features. > [!NOTE] > The `"Empty"` value for `-IncludedApps` or `-ExcludedApps` is different from an empty string `""`. The rules are as follows: @@ -128,7 +128,7 @@ This example enables pre-authentication overall and denies requests that are not This parameter specifies that the operation of the cmdlet is to Add a setting to the allow list or deny list. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddListItem Aliases: @@ -144,13 +144,13 @@ Accept wildcard characters: False This parameter value contains the apps ids to configure within the `-ExcludedApps` scope. Possible values include: `""`, `"Empty"`, or a comma-separated list of app IDs. ```yaml -Type: String +Type: System.String Parameter Sets: AddListItem Aliases: Required: False Position: Named -Default value: "" +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -160,13 +160,13 @@ Accept wildcard characters: False This parameter value contains the feature names to configure within the `-ExcludedFeatures` scope. Possible values include: `""` or a comma-separated list of feature names (see NOTES section below). ```yaml -Type: String +Type: System.String Parameter Sets: AddListItem Aliases: Required: False Position: Named -Default value: "" +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -176,7 +176,7 @@ Accept wildcard characters: False This parameter identifies the list item setting to remove from the current configuration. It is only required with the `-Remove` parameter. ```yaml -Type: String +Type: System.String Parameter Sets: RemoveListItem Aliases: @@ -192,13 +192,13 @@ Accept wildcard characters: False This parameter value contains the app ids to configure within the `-IncludedApps` scope. Possible values include: `""`, `"Empty"`, or a comma-separated list of app IDs. ```yaml -Type: String +Type: System.String Parameter Sets: AddListItem Aliases: Required: False Position: Named -Default value: "" +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -214,7 +214,7 @@ Aliases: Required: False Position: Named -Default value: "" +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -230,7 +230,7 @@ Aliases: Required: True Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -240,7 +240,7 @@ Accept wildcard characters: False This parameter specifies that the operation of the cmdlet is to Remove a setting from the allow list or deny list. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RemoveListItem Aliases: @@ -253,7 +253,7 @@ Accept wildcard characters: False ### -Type -This parameter indicates whether the cmdlet is interacting with the allow list or the deny list. +This parameter indicates whether the cmdlet is interacting with the allow list or the deny list. ```yaml Type: TenantPreAuthSettingsListType @@ -269,7 +269,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-5.1). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantRenameSitePrioritization.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantRenameSitePrioritization.md similarity index 92% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantRenameSitePrioritization.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantRenameSitePrioritization.md index d0a3c6b27..f72e1c3c1 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantRenameSitePrioritization.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantRenameSitePrioritization.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenantrenamesiteprioritization applicable: SharePoint Online @@ -20,7 +20,7 @@ Allows prioritization of a site for early execution, as part of [Advanced Tenant Set-SPOTenantRenameSitePrioritization -SiteUrl [] ``` ## DESCRIPTION -Allows for the specified site to be prioritized. +Allows for the specified site to be prioritized. As part of [Advanced Tenant Rename](/sharepoint/change-your-sharepoint-domain-name#advanced-tenant-rename-preview), organizations can prioritize up to 4,000 sites for initial execution among all other sites in your organization as part of the overall rename operation. @@ -46,8 +46,7 @@ This example prioritizes the 'projectx' site within the Advanced Tenant Rename. Specifies the full site URL of the site you wish to prioritize. This can be either a OneDrive for Business or SharePoint Online site. Root URLs (e.g., contoso.sharepoint.com, contoso-admin.sharepoint.com or contoso-my.sharepoint.com) can't be prioritized. ```yaml - -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -60,7 +59,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantRestrictedSearchMode.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantRestrictedSearchMode.md new file mode 100644 index 000000000..cbf9d1310 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantRestrictedSearchMode.md @@ -0,0 +1,62 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Set-SPOTenantRestrictedSearchMode + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-SPOTenantRestrictedSearchMode [-Mode] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Mode +{{ Fill Mode Description }} + +```yaml +Type: Microsoft.Online.SharePoint.TenantAdministration.RestrictedSearchMode +Parameter Sets: (All) +Aliases: +Accepted values: Disabled, Enabled + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md similarity index 92% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md index 56a272124..8d645367e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantSyncClientRestriction.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenantsyncclientrestriction applicable: SharePoint Online @@ -19,23 +19,25 @@ Controls tenant-wide options and restrictions specific to syncing files. ## SYNTAX ### Blocking - -```powershell -Set-SPOTenantSyncClientRestriction [-BlockMacSync] [-DomainGuids ] [-Enable] [] ``` - -### ReportProblemDialogFeature - -```powershell -Set-SPOTenantSyncClientRestriction -DisableReportProblemDialog [] +Set-SPOTenantSyncClientRestriction [-Enable] [-DomainGuids ] [-BlockMacSync] [] ``` ### FileExclusion - -```powershell +``` Set-SPOTenantSyncClientRestriction [-ExcludedFileExtensions ] [] ``` +### GrooveBlockOptions +``` +Set-SPOTenantSyncClientRestriction [-GrooveBlockOption ] [] +``` + +### ReportProblemDialogFeature +``` +Set-SPOTenantSyncClientRestriction -DisableReportProblemDialog [] +``` + ## DESCRIPTION This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see [Cmdlet Parameter Sets](https://msdn.microsoft.com/library/dd878348(VS.85).aspx). @@ -100,7 +102,7 @@ Any file extension may be blocked using this feature, but note that it may take ## EXAMPLES -### --------------------EXAMPLE 1--------------------- +### EXAMPLE 1 ```powershell Set-SPOTenantSyncClientRestriction -Enable -DomainGuids "786548DD-877B-4760-A749-6B1EFBC1190A; 877564FF-877B-4760-A749-6B1EFBC1190A" @@ -108,7 +110,7 @@ Set-SPOTenantSyncClientRestriction -Enable -DomainGuids "786548DD-877B-4760-A74 This example enables the feature for the tenancy and adds the domains GUIDs to the safe recipient list. -### --------------------EXAMPLE 2------------------ +### EXAMPLE 2 ```powershell Set-SPOTenantSyncClientRestriction -Enable -DomainGuids "786548DD-877B-4760-A749-6B1EFBC1190A; 877564FF-877B-4760-A749-6B1EFBC1190A" -BlockMacSync:$true @@ -116,7 +118,7 @@ Set-SPOTenantSyncClientRestriction -Enable -DomainGuids "786548DD-877B-4760-A74 This example turns on the Block Mac sync functionality. -### --------------------EXAMPLE 3------------------ +### EXAMPLE 3 ```powershell Set-SPOTenantSyncClientRestriction -ExcludedFileExtensions "pptx;docx;xlsx" @@ -124,7 +126,7 @@ Set-SPOTenantSyncClientRestriction -ExcludedFileExtensions "pptx;docx;xlsx" This example blocks syncing of PowerPoint, Word, and Excel file types using the new sync client (OneDrive.exe). -### --------------------EXAMPLE 4------------------ +### EXAMPLE 4 ```powershell Set-SPOTenantSyncClientRestriction -ExcludedFileExtensions "" @@ -140,7 +142,7 @@ 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. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: Blocking Aliases: Applicable: SharePoint Online @@ -155,7 +157,7 @@ Accept wildcard characters: False ### -DisableReportProblemDialog ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: ReportProblemDialogFeature Aliases: Applicable: SharePoint Online @@ -172,7 +174,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: Blocking Aliases: Applicable: SharePoint Online @@ -189,7 +191,7 @@ Accept wildcard characters: False Enables the feature to block sync originating from domains that are not present in the safe recipients list. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: Blocking Aliases: Applicable: SharePoint Online @@ -209,7 +211,7 @@ Blocks certain file types from syncing with the new sync client (OneDrive.exe). > It may take up to one hour for changes to take effect. ```yaml -Type: String +Type: System.String Parameter Sets: FileExclusion Aliases: Applicable: SharePoint Online @@ -221,6 +223,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -GrooveBlockOption +{{ Fill GrooveBlockOption Description }} + +```yaml +Type: System.String +Parameter Sets: GrooveBlockOptions +Aliases: +Accepted values: OptOut, HardOptIn, SoftOptIn + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantTaxonomyReplicationParameters.md similarity index 92% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantTaxonomyReplicationParameters.md index 884d47fc7..d885782fe 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOTenantTaxonomyReplicationParameters.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spotenanttaxonomyreplicationparameters applicable: SharePoint Online @@ -18,18 +18,16 @@ Select groups for replication ## SYNTAX -### ReplicateAllGroups - -```powershell -Set-SPOTenantTaxonomyReplicationParameters [-ReplicateAllGroups] [] +### ReplicateSelectedGroups (Default) ``` - -### ReplicateSelectedGroups - -```powershell Set-SPOTenantTaxonomyReplicationParameters -ReplicatedGroups [] ``` +### ReplicateAllGroups +``` +Set-SPOTenantTaxonomyReplicationParameters [-ReplicateAllGroups] [] +``` + ## DESCRIPTION Before using this cmdlet, make sure you connect to SharePoint Online using [Connect-SPOService](Connect-SPOService.md) and the desirable satellite location URL as the -Url parameter. @@ -62,7 +60,7 @@ Tenant admin can also reset to replicate all the groups. This parameter specifies whether all groups should be replicated. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ReplicateAllGroups Aliases: Applicable: SharePoint Online @@ -78,7 +76,7 @@ Accept wildcard characters: False Specifies a comma-separated list of groups that should be replicated. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ReplicateSelectedGroups Aliases: Applicable: SharePoint Online @@ -93,6 +91,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUnifiedGroup.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUnifiedGroup.md similarity index 72% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUnifiedGroup.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUnifiedGroup.md index 8c59619c5..e83fdb28c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUnifiedGroup.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUnifiedGroup.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spounifiedgroup applicable: SharePoint Online @@ -18,8 +18,8 @@ Sets the Preferred Data Location (PDL) for the specified Office 365 Group. The c ## SYNTAX -```powershell -Set-SPOUnifiedGroup [-GroupAlias] [-PreferredDataLocation] [] +``` +Set-SPOUnifiedGroup [-GroupAlias] [-PreferredDataLocation] [] ``` ## DESCRIPTION @@ -43,12 +43,12 @@ Sets the PDL for the Office 365 Group named 'EUTeam' to EUR (Europe). The alias of the Office 365 Group. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -59,25 +59,32 @@ Accept wildcard characters: False The Preferred Data Location for the Office 365 Group. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +### System.Object ## NOTES ## RELATED LINKS -[Get-SPOUnifiedGroup](https://learn.microsoft.com/powershell/module/sharepoint-online/get-spounifiedgroup) +[Get-SPOUnifiedGroup](/powershell/module/sharepoint-online/get-spounifiedgroup) -[Move a SharePoint site to a different geo location](https://learn.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations) +[Move a SharePoint site to a different geo location](/office365/enterprise/move-sharepoint-between-geo-locations) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUser.md similarity index 80% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUser.md index 19b6d21c7..ce4ea6ae7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOUser.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spouser applicable: SharePoint Online @@ -18,8 +18,9 @@ Configures properties on an existing user. ## SYNTAX -```powershell -Set-SPOUser -IsSiteCollectionAdmin -LoginName -Site [] +``` +Set-SPOUser -Site -LoginName [-IsSiteCollectionAdmin ] + [-UpdateUserTypeFromAzureAD] [] ``` ## DESCRIPTION @@ -29,7 +30,7 @@ That is, to add or remove a user as a SharePoint Online site collection administ You must be at least a SharePoint administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). This cmdlet is not supported for use with granular delegated admin privileges (GDAP). @@ -58,11 +59,11 @@ This example makes guest user adelev_fabrikam.onmicrosoft.com a SharePoint Onlin Specifies whether the user is a site collection administrator. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -74,7 +75,7 @@ Accept wildcard characters: False Specifies the user name. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -90,7 +91,7 @@ Accept wildcard characters: False Specifies the full URL of the site collection. It must be in a valid managed path in the company's site. ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -103,10 +104,10 @@ Accept wildcard characters: False ### -UpdateUserTypeFromAzureAD If the UserType property of an existing user is changed in Microsoft Entra ID from Member to Guest or vice-versa, this parameter can be used to update it in SharePoint Online. -For more information, see [Convert UserType](https://learn.microsoft.com/azure/active-directory/b2b/user-properties#convert-usertype). +For more information, see [Convert UserType](/azure/active-directory/b2b/user-properties#convert-usertype). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -129,6 +130,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOUser](Get-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOWebTheme.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOWebTheme.md similarity index 77% rename from sharepoint/sharepoint-ps/sharepoint-online/Set-SPOWebTheme.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOWebTheme.md index 673175cb6..db47ac8d7 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOWebTheme.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOWebTheme.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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-spowebtheme applicable: SharePoint Online @@ -18,7 +18,7 @@ Sets the theme for a SharePoint site. ## SYNTAX -```powershell +``` Set-SPOWebTheme [-Theme] [-Web] [-WhatIf] [-Confirm] [] ``` @@ -43,14 +43,14 @@ This example sets the "Custom Cyan" theme to the https://contoso.sharepoint.com/ Name of the theme or SPOTheme object ```yaml -Type: SpoThemePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind Parameter Sets: (All) -Aliases: +Aliases: Identity, Name Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: True +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` @@ -58,7 +58,7 @@ Accept wildcard characters: False Url of the site ```yaml -Type: SpoSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -75,7 +75,7 @@ Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf Applicable: SharePoint Online @@ -87,15 +87,14 @@ Accept wildcard characters: False ``` ### -WhatIf - -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` +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: SharePoint Online + Required: False Position: Named Default value: None @@ -104,13 +103,16 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS +### Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOAuditDataCollectionForActivityInsights.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOAuditDataCollectionForActivityInsights.md index 274de273d..608faed94 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOAuditDataCollectionForActivityInsights.md @@ -1,5 +1,5 @@ ---- -external help file: sharepointonline.xml +--- +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/start-spoauditdatacollectionforactivityinsights applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Start-SPOAuditDataCollectionForActivityInsights schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -48,7 +48,7 @@ This example will start collecting audit data related to the generation of 'Anyo Specifies the entity for which the corresponding audit data should be collected. ```yaml -Type: OptInReportEntityEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.OptInReportEntityEnum Parameter Sets: (All) Aliases: Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights @@ -61,8 +61,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md similarity index 65% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md index 235be9e3c..c4e9f9bb8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCopilotAgentInsightsReport.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spocopilotagentinsightsreport applicable: SharePoint Online @@ -22,8 +22,9 @@ Using this cmdlet, administrators may trigger the build of a new Copilot agent i ## SYNTAX -```powershell -Start-SPOCopilotAgentInsightsReport [-ReportPeriodInDays ] [-Force ] +``` +Start-SPOCopilotAgentInsightsReport [-Force] [-ReportPeriodInDays ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -39,7 +40,7 @@ After this cmdlet is executed, the Copilot agent insight report generation reque ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Start-SPOCopilotAgentInsightsReport @@ -47,7 +48,7 @@ Start-SPOCopilotAgentInsightsReport Example 1 generates the Copilot agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Start-SPOCopilotAgentInsightsReport –ReportPeriodInDays 14 @@ -57,33 +58,64 @@ Example 2 generates the Copilot agent insight report for a specified duration of ## PARAMETERS +### -Force + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReportPeriodInDays 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: Int +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online - + Required: False Position: Named -Default value: 1 +Default value: None Accept pipeline input: False -Accept wildcard characters: False +Accept wildcard characters: False ``` -### -Force +### -Confirm +Prompts you for confirmation before running the cmdlet. -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: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - +Aliases: wi + Required: False Position: Named Default value: None @@ -92,11 +124,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## OUTPUTS -## Related Links +### System.Object -[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) +## NOTES -[Get-SPOCopilotAgentInsightsReport](./Get-SPOCopilotAgentInsightsReport.md) \ No newline at end of file +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantGroupContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantGroupContentMove.md new file mode 100644 index 000000000..368159856 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantGroupContentMove.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Start-SPOCrossTenantGroupContentMove + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-SPOCrossTenantGroupContentMove [-SourceGroupAlias] [-TargetGroupAlias] + [-TargetCrossTenantHostUrl] [[-PreferredMoveBeginDate] ] + [[-PreferredMoveEndDate] ] [-ValidationOnly] [-Force] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMoveBeginDate +{{ Fill PreferredMoveBeginDate Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMoveEndDate +{{ Fill PreferredMoveEndDate Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceGroupAlias +{{ Fill SourceGroupAlias Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetCrossTenantHostUrl +{{ Fill TargetCrossTenantHostUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetGroupAlias +{{ Fill TargetGroupAlias Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationOnly +{{ Fill ValidationOnly Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantSiteContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantSiteContentMove.md new file mode 100644 index 000000000..8be0b0c1e --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantSiteContentMove.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Start-SPOCrossTenantSiteContentMove + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-SPOCrossTenantSiteContentMove [-SourceSiteUrl] [-TargetSiteUrl] + [-TargetCrossTenantHostUrl] [[-PreferredMoveBeginDate] ] + [[-PreferredMoveEndDate] ] [-ValidationOnly] [-Force] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMoveBeginDate +{{ Fill PreferredMoveBeginDate Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMoveEndDate +{{ Fill PreferredMoveEndDate Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSiteUrl +{{ Fill SourceSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetCrossTenantHostUrl +{{ Fill TargetCrossTenantHostUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSiteUrl +{{ Fill TargetSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationOnly +{{ Fill ValidationOnly Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantUserContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantUserContentMove.md new file mode 100644 index 000000000..a09349e08 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOCrossTenantUserContentMove.md @@ -0,0 +1,153 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Start-SPOCrossTenantUserContentMove + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-SPOCrossTenantUserContentMove [-SourceUserPrincipalName] [-TargetUserPrincipalName] + [-TargetCrossTenantHostUrl] [[-PreferredMoveBeginDate] ] + [[-PreferredMoveEndDate] ] [-ValidationOnly] [-Force] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMoveBeginDate +{{ Fill PreferredMoveBeginDate Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreferredMoveEndDate +{{ Fill PreferredMoveEndDate Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceUserPrincipalName +{{ Fill SourceUserPrincipalName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetCrossTenantHostUrl +{{ Fill TargetCrossTenantHostUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUserPrincipalName +{{ Fill TargetUserPrincipalName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidationOnly +{{ Fill ValidationOnly Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPODataAccessGovernanceInsight.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPODataAccessGovernanceInsight.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPODataAccessGovernanceInsight.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPODataAccessGovernanceInsight.md index 2a135c17a..efae44886 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPODataAccessGovernanceInsight.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPODataAccessGovernanceInsight.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spodataaccessgovernanceinsight applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Start-SPODataAccessGovernanceInsight schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -20,65 +20,41 @@ This cmdlet generates Data Access Governance (DAG) reports meant to provide insi ## SYNTAX ### EEEUParameterSet - -```powershell -Start-SPODataAccessGovernanceInsight --ReportEntity --Workload --ReportType --Name -[-Template ] -[-Privacy ] -[-SiteSensitivityLabelGUID ] -[] +``` +Start-SPODataAccessGovernanceInsight -ReportEntity -Workload + -ReportType -Name + [-Template ] + [-Privacy ] [-SiteSensitivityLabelGUID ] + [] ``` ### SharingLinkParameterSet - -```powershell -Start-SPODataAccessGovernanceInsight --ReportEntity --Workload --ReportType [] +``` +Start-SPODataAccessGovernanceInsight -ReportEntity -Workload + -ReportType [] ``` ### LabelParameterSet - -```powershell -Start-SPODataAccessGovernanceInsight --ReportEntity --Workload --ReportType -[-FileSensitivityLabelName ] --FileSensitivityLabelGUID -[] +``` +Start-SPODataAccessGovernanceInsight -ReportEntity -Workload + -ReportType [-FileSensitivityLabelName ] -FileSensitivityLabelGUID + [] ``` ### SitePermissionsParameterSet - -```powershell -Start-SPODataAccessGovernanceInsight --ReportEntity --Workload --ReportType --Name -[-Template ] -[-Privacy ] -[-SiteSensitivityLabelGUID ] --CountOfUsersMoreThan -[] +``` +Start-SPODataAccessGovernanceInsight -ReportEntity -Workload + -ReportType -Name + [-Template ] + [-Privacy ] [-SiteSensitivityLabelGUID ] + -CountOfUsersMoreThan [] ``` ### UserPermissionsParameterSet - -```powershell -Start-SPODataAccessGovernanceInsight --ReportEntity --Workload --ReportType --Name --UserIDList -[] +``` +Start-SPODataAccessGovernanceInsight -ReportEntity -Workload + -ReportType -Name -UserIDList + [] ``` ## DESCRIPTION @@ -108,7 +84,7 @@ The above cmdlet generates a list of SharePoint sites which can be accessed by m Specifies the threshold of oversharing as defined by the number of users that can access the site. The number of users that can access the site are determined by expanding all users, groups across all permissions (at site level and at the level of any item with unqiue permissions), deduplicate and arrive at a unique number. Minimum value is 0. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: SitePermissionsParameterSet Aliases: @@ -124,7 +100,7 @@ Accept wildcard characters: False Specifies the GUID for the sensitivity label for the file. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: LabelParameterSet Aliases: @@ -140,7 +116,7 @@ Accept wildcard characters: False Specifies the name of the sensitivity label for the file. ```yaml -Type: String +Type: System.String Parameter Sets: LabelParameterSet Aliases: @@ -156,8 +132,8 @@ Accept wildcard characters: False Specifies the name to be given to the generated report. ```yaml -Type: String -Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet +Type: System.String +Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet, UserPermissionsParameterSet Aliases: Required: True @@ -172,7 +148,7 @@ Accept wildcard characters: False Specifies the privacy setting of the Microsoft 365 group. Relevant in case of filtering the report for group connected sites. ```yaml -Type: PrivacyEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.PrivacyEnum Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet Aliases: Accepted values: All, Private, Public @@ -189,7 +165,7 @@ Accept wildcard characters: False Specifies the entity that could cause oversharing and hence tracked by these reports. ```yaml -Type: ReportEntityEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.ReportEntityEnum Parameter Sets: (All) Aliases: Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers, PermissionsReport @@ -206,7 +182,7 @@ Accept wildcard characters: False Specifies the time period of data based on which DAG report is generated. A 'Snapshot' report will have the latest data as of the report generation time. A 'RecentActivity' report will be based on data in the last 28 days. ```yaml -Type: ReportTypeEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.ReportTypeEnum Parameter Sets: (All) Aliases: Accepted values: Snapshot, RecentActivity @@ -240,7 +216,7 @@ Specifies the template of the site. Relevant in case a report should be generate ```yaml Type: System.Collections.Generic.List`1[Microsoft.Online.SharePoint.TenantAdministration.TemplateEnum] -Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet, UserPermissionsParameterSet +Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet Aliases: Accepted values: AllSites, ClassicSites, CommunicationSites, TeamSites, OtherSites @@ -251,15 +227,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Workload +### -UserIDList -Specifies whether the report is for SharePoint sites or OneDrive accounts. +Specifies the Entra object IDs of the users for whom permissions report should be generated. Can be fetched using the `Get-MgUser` command from [Microsoft Graph PowerShell](/powershell/module/microsoft.graph.users/get-mguser). ```yaml -Type: WorkloadEnum -Parameter Sets: (All) +Type: System.Collections.Generic.List`1[System.Guid] +Parameter Sets: UserPermissionsParameterSet Aliases: -Accepted values: SharePoint, OneDriveForBusiness Required: True Position: Named @@ -268,14 +243,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserIDList +### -Workload -Specifies the Entra object IDs of the users for whom permissions report should be generated. Can be fetched using the `Get-MgUser` command from [Microsoft Graph PowerShell](/powershell/module/microsoft.graph.users/get-mguser). +Specifies whether the report is for SharePoint sites or OneDrive accounts. ```yaml -Type: System.Collections.Generic.List`1[System.Guid] -Parameter Sets: UserPermissionsParameterSet +Type: Microsoft.Online.SharePoint.TenantAdministration.WorkloadEnum +Parameter Sets: (All) Aliases: +Accepted values: SharePoint, OneDriveForBusiness Required: True Position: Named @@ -285,7 +261,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOEnterpriseAppInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md similarity index 66% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOEnterpriseAppInsightsReport.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md index 401932175..770f4c63c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOEnterpriseAppInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOEnterpriseAppInsightsReport.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spoenterpriseappinsightsreport applicable: SharePoint Online @@ -10,7 +10,7 @@ ms.author: sumikumar ms.reviewer: manager: hikakar --- - + # Start-SPOEnterpriseAppInsightsReport ## SYNOPSIS @@ -19,8 +19,9 @@ This cmdlet enables administrator to trigger the build of a new enterprise appli ## SYNTAX -```powershell -Start-SPOEnterpriseAppInsightsReport [-ReportPeriodInDays ] [-Force ] +``` +Start-SPOEnterpriseAppInsightsReport [-Force] [-ReportPeriodInDays ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -36,7 +37,7 @@ After this cmdlet is executed, the enterprise application insights report genera ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Start-SPOEnterpriseAppInsightsReport @@ -44,7 +45,7 @@ Start-SPOEnterpriseAppInsightsReport Example 1 generates the enterprise application insights report for a default duration of 1 day as the parameter `–ReportPeriodInDays` is not provided. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Start-SPOEnterpriseAppInsightsReport –ReportPeriodInDays 14 @@ -54,33 +55,64 @@ Example 2 generates the enterprise application insights report for a specified d ## PARAMETERS +### -Force + +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 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReportPeriodInDays 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: Int +Type: System.Int32 Parameter Sets: (All) Aliases: Applicable: SharePoint Online - + Required: False Position: Named Default value: None Accept pipeline input: False -Accept wildcard characters: False +Accept wildcard characters: False ``` -### -Force +### -Confirm +Prompts you for confirmation before running the cmdlet. -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: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - +Aliases: wi + Required: False Position: Named Default value: None @@ -89,11 +121,20 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## NOTES -## Related Links +## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) -[Get-SPOEnterpriseAppInsightsReport](./Get-SPOEnterpriseAppInsightsReport.md) \ No newline at end of file +[Get-SPOEnterpriseAppInsightsReport](./Get-SPOEnterpriseAppInsightsReport.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersInsightsReport.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersInsightsReport.md index 836e6e7c3..29e759e9a 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersInsightsReport.md @@ -1,5 +1,5 @@ ---- -external help file: sharepointonline.xml +--- +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/start-spoinformationbarriersinsightsreport applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Start-SPOInformationBarriersInsightsReport schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -19,7 +19,7 @@ Generates a new report to identify and discover the usage patterns of Informatio ## SYNTAX -```powershell +``` Start-SPOInformationBarriersInsightsReport [-Yes ] [-WhatIf] [-Confirm] [] ``` @@ -44,7 +44,7 @@ This example generates IB reports without asking for further confirmation. This parameter provides confirmation to generate the IB report. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -60,7 +60,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -77,7 +77,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -89,8 +89,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md new file mode 100644 index 000000000..d599a2e35 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Start-SPOInformationBarriersPolicyComplianceReport + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-SPOInformationBarriersPolicyComplianceReport [-UpdateOneDriveSegments] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -UpdateOneDriveSegments +{{ Fill UpdateOneDriveSegments Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPORestrictedAccessForSitesInsights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md similarity index 62% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPORestrictedAccessForSitesInsights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md index 5f6c8e0a6..b82e6025c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPORestrictedAccessForSitesInsights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedAccessForSitesInsights.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-sporestrictedaccessforsitesinsights applicable: SharePoint Online @@ -10,7 +10,7 @@ ms.author: itambakhe ms.reviewer: manager: --- - + # Start-SPORestrictedAccessForSitesInsights ## SYNOPSIS @@ -19,12 +19,9 @@ This cmdlet enables administrator to trigger the build of a new restricted acces ## SYNTAX -```powershell -Start-SPORestrictedAccessForSitesInsights -RACProtectedSites [-Force ] ``` - -```powershell -Start-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy [-Force ] +Start-SPORestrictedAccessForSitesInsights [-RACProtectedSites] [-ActionsBlockedByPolicy] [-Force] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,7 +30,7 @@ After this cmdlet is executed, the restricted access control insights report gen ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Start-SPORestrictedAccessForSitesInsights -RACProtectedSites @@ -41,7 +38,7 @@ Start-SPORestrictedAccessForSitesInsights -RACProtectedSites Example 1 generates the restricted access control report which contains insights about the list of sites protected with the policy. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Start-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy @@ -51,16 +48,16 @@ Example 2 generates the restricted access control report which contains insights ## PARAMETERS -### -RACProtectedSites +### -ActionsBlockedByPolicy It is an optional parameter, and it specifies the type of report generation to be triggered. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: SharePoint Online - + Required: False Position: Named Default value: None @@ -68,16 +65,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ActionsBlockedByPolicy +### -Force -It is an optional parameter, and it specifies the type of report generation to be triggered. +It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: SharePoint Online - + Required: False Position: Named Default value: None @@ -85,16 +82,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -RACProtectedSites -It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions. +It is an optional parameter, and it specifies the type of report generation to be triggered. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Applicable: SharePoint Online - + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + Required: False Position: Named Default value: None @@ -103,10 +131,19 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## NOTES -## Related Links +## RELATED LINKS [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedContentDiscoverabilityReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedContentDiscoverabilityReport.md new file mode 100644 index 000000000..a0796f63e --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPORestrictedContentDiscoverabilityReport.md @@ -0,0 +1,92 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Start-SPORestrictedContentDiscoverabilityReport + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-SPORestrictedContentDiscoverabilityReport [-Force] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md similarity index 78% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md index 65b39f22a..fdc477290 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteContentMove.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spositecontentmove applicable: SharePoint Online @@ -18,21 +18,20 @@ Start a job to move a particular user or group of users to be moved across geo l ## SYNTAX -### UrlAndDestinationDataLocation - -```powershell +### UrlAndDestinationDataLocation (Default) +``` Start-SPOSiteContentMove [-SourceSiteUrl] [-DestinationDataLocation] [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [[-Reserved] ] - [-ValidationOnly] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] - [-SuppressBcsCheck][] + [-ValidationOnly] [-Force] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] + [-SuppressBcsCheck] [] ``` ### UrlAndDestinationUrl - -```powershell -Start-SPOSiteContentMove [-SourceSiteUrl] [-DestinationUrl] [[-PreferredMoveBeginDate] ] - [[-PreferredMoveEndDate] ] [[-Reserved] ] [-ValidationOnly] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] - [-SuppressAllWarnings] [-SuppressBcsCheck] [] +``` +Start-SPOSiteContentMove [-SourceSiteUrl] [-DestinationUrl] + [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [[-Reserved] ] + [-ValidationOnly] [-Force] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] + [-SuppressBcsCheck] [] ``` ## DESCRIPTION @@ -46,7 +45,7 @@ UrlAndDestinationUrl: These parameters allow a SharePoint administrator to move ### EXAMPLE 1 ```powershell -Start-SPOSiteContentMove -SourceSiteUrl https://contosoenergy.sharepoint.com/sites/hr -DestinationDataLocation EUR +Start-SPOSiteContentMove -SourceSiteUrl https://contosoenergy.sharepoint.com/sites/hr -DestinationDataLocation EUR ``` Starts the movement of the content on to the EUR destination. @@ -71,11 +70,11 @@ Starts a site geo move for and a ### -DestinationDataLocation -Defines the new destination of the content that you want to move. This is the 3 letter data location value. +Defines the new destination of the content that you want to move. This is the 3 letter data location value. ```yaml -Type: String -Parameter Sets: UrlAndDestinationDataLocation, GroupNameAndDestinationDataLocation +Type: System.String +Parameter Sets: UrlAndDestinationDataLocation Aliases: Applicable: SharePoint Online Required: True @@ -90,24 +89,39 @@ Accept wildcard characters: False Destination URL is optional in cases where the administrator wants to perform a site rename as part of the move. ```yaml -Type: String +Type: System.String Parameter Sets: UrlAndDestinationUrl Aliases: Applicable: SharePoint Online -Required: False +Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreferredMoveBeginDate -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. +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: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -120,10 +134,10 @@ Accept wildcard characters: False ### -PreferredMoveEndDate -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. +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: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -139,7 +153,7 @@ Accept wildcard characters: False Reserved for Microsoft Internal use. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -152,11 +166,11 @@ Accept wildcard characters: False ### -SourceSiteUrl -Specifies the source URL of the site collection you want to move. +Specifies the source URL of the site collection you want to move. ```yaml -Type: String -Parameter Sets: UrlAndDestinationDataLocation, UrlAndDestinationUrl +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True @@ -166,27 +180,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ValidationOnly - -This parameter will perform a validation check on whether the site can be moved and will not execute the move. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SuppressAllWarnings Suppress all warning messages. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -201,7 +199,7 @@ Accept wildcard characters: False Suppress checking for Business Connectivity Services used with the associated site. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -216,7 +214,7 @@ Accept wildcard characters: False Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -231,7 +229,7 @@ Accept wildcard characters: False Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -242,13 +240,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ValidationOnly + +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 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md similarity index 60% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index 699d98990..d4eabf52b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/Start-SPOSiteOpticalCharacterRecognitionBackfill applicable: SharePoint Online @@ -21,14 +21,14 @@ Initiates a job to trigger the OCR process for all files for the selected site. ## SYNTAX -```Powershell - -Start-SPOSiteOpticalCharacterRecognitionBackfill [-Site] +``` +Start-SPOSiteOpticalCharacterRecognitionBackfill -Site [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -This cmdlet starts a job to trigger the OCR process for files that have either never been OCR processed or have been modified since the last OCR process. This ensures all relevant content in the site is recognized and indexed for improved searchability and accessibility. +This cmdlet starts a job to trigger the OCR process for files that have either never been OCR processed or have been modified since the last OCR process. This ensures all relevant content in the site is recognized and indexed for improved searchability and accessibility. OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. @@ -53,21 +53,61 @@ Starts OCR process for all content that hasn't been processed before in the sele Specifies the site where OCR process should be enabled on. ```yaml -Type: SpoSitePipeBind -Parameter Sets: Default +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind + +## OUTPUTS + +### System.Object -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +## NOTES ## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md similarity index 72% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteRename.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md index ac7e1cd09..659e513b2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteRename.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spositerename applicable: SharePoint Online @@ -21,10 +21,10 @@ Starts a job to rename a site. You can change the URL, and optionally the site t ## SYNTAX -```Powershell -Start-SPOSiteRename [-Identity] [-NewSiteUrl] [[-NewSiteTitle] ] - [[-SuppressMarketplaceAppCheck]] [[-SuppressWorkflow2013Check]] [-ValidationOnly] [[-Reserved] ] [-WhatIf] [-Confirm] - [] +``` +Start-SPOSiteRename -Identity -NewSiteUrl [-NewSiteTitle ] + [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] [-SuppressBcsCheck] + [-ValidationOnly] [-Reserved ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -72,25 +72,26 @@ Starts the **simulation** rename of the SPO site with name "samplesite" to "rena Specifies the original URL of the site collection. ```yaml -Type: String -Parameter Sets: Default +Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NewSiteUrl +### -NewSiteTitle -Specifies the new desired URL. +Specifies the new Title of the site. ```yaml -Type: String -Parameter Sets: Default +Type: System.String +Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: True @@ -100,120 +101,149 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NewSiteTitle +### -NewSiteUrl -Specifies the new Title of the site. +Specifies the new desired URL. ```yaml -Type: String -Parameter Sets: Default +Type: System.String +Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SuppressMarketplaceAppCheck +### -Reserved -Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site. +Reserved for Microsoft internal use. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: 4 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SuppressWorkflow2013Check +### -SuppressAllWarnings +{{ Fill SuppressAllWarnings Description }} -Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site. +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SuppressBcsCheck +{{ Fill SuppressBcsCheck Description }} ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Applicable: SharePoint Online Required: False -Position: 5 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ValidationOnly +### -SuppressMarketplaceAppCheck -Verifies that the site address can be changed. +Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: 5 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Reserved +### -SuppressWorkflow2013Check -Reserved for Microsoft internal use. +Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: 4 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -ValidationOnly -Simulation of what would happen if you run the script without modifying anything. +Verifies that the site address can be changed. ```yaml -Type: String -Parameter Sets: UrlAndDestinationDataLocation, UrlAndDestinationUrl +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm +Prompts you for confirmation before running the cmdlet. -Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters` +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Applicable: SharePoint Online Required: False -Position: 5 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -223,9 +253,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteReview.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteReview.md similarity index 93% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteReview.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteReview.md index 2590c4b40..ebf8b708b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteReview.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOSiteReview.md @@ -1,5 +1,5 @@ ---- -external help file: sharepointonline.xml +--- +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/start-spositereview applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Start-SPOSiteReview schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -41,7 +41,7 @@ The above cmdlet initiates site access review for the given site as per overshar SharePoint Administrator to add comments to provide more context to the site owner regarding the purpose of the review. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -56,7 +56,7 @@ Accept wildcard characters: False Specifies the ID of the particular report which contains sites for which site access review should be initiated. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -71,7 +71,7 @@ Accept wildcard characters: False Specifies the ID of the site for which site access review should be initiated. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -83,7 +83,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOTenantRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOTenantRename.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md index 93375eca1..194bc8fd8 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOTenantRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOTenantRename.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spotenantrename applicable: SharePoint Online @@ -20,12 +20,13 @@ ms.reviewer: Starts a job to change the SharePoint domain name for your organization in Microsoft 365. For example, if the name of your organization changes from "Contoso" to "Fabrikam," you can change contoso.sharepoint.com to fabrikam.sharepoint.com. > [!WARNING] -> Changing your SharePoint domain name might take several hours to days depending on the number of sites and OneDrive users that you have. We strongly recommend that you make this change during a period of low usage (like a weekend) and tell users to avoid accessing SharePoint and OneDrive content during the change. In addition, any actions that create new OneDrives and sites (such as creating a new team or private channel in Microsoft Teams) will be temporarily blocked during the rename. +> Changing your SharePoint domain name might take several hours to days depending on the number of sites and OneDrive users that you have. We strongly recommend that you make this change during a period of low usage (like a weekend) and tell users to avoid accessing SharePoint and OneDrive content during the change. In addition, any actions that create new OneDrives and sites (such as creating a new team or private channel in Microsoft Teams) will be temporarily blocked during the rename. ## SYNTAX -```Powershell -Start-SPOTenantRename -DomainName -ScheduledDateTime [-WhatIf] [-Confirm] [] +``` +Start-SPOTenantRename -DomainName -ScheduledDateTime [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -52,13 +53,13 @@ Specifies the domain name that the current SharePoint domain name will be rename > The domain name must already have been successfully added to Microsoft Entra ID as per the instructions at [Step 1: Add the new domain name](https://aka.ms/SPOTenantRename#step-1-add-the-new-domain-name). If the domain name does not exist or was not successfully added, then this cmdlet will return an error. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,45 +70,45 @@ Accept wildcard characters: False 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: DateTime +Type: System.DateTime Parameter Sets: (All) +Aliases: Applicable: SharePoint Online Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf - -Not supported for this cmdlet. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Applicable: SharePoint Online -Required: True -Position: 0 + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before executing the command. For more information, type the following command: `get-help about_commonparameters`. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Applicable: SharePoint Online - Required: False -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -117,9 +118,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Rename your SharePoint domain](https://aka.ms/SPOTenantRename) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUnifiedGroupMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUnifiedGroupMove.md similarity index 81% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUnifiedGroupMove.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUnifiedGroupMove.md index d7a53b8f9..2af31a882 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUnifiedGroupMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUnifiedGroupMove.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spounifiedgroupmove applicable: SharePoint Online @@ -18,13 +18,16 @@ Initiates the move of an Office 365 Group to a new geo location ## SYNTAX -```powershell -Start-SPOUnifiedGroupMove [-GroupAlias] [-DestinationDataLocation] [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [[-Reserved] ] [-ValidationOnly] [-Force] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] [-SuppressBcsCheck] [] +``` +Start-SPOUnifiedGroupMove [-GroupAlias] [-DestinationDataLocation] + [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [[-Reserved] ] + [-ValidationOnly] [-Force] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] + [-SuppressBcsCheck] [] ``` ## DESCRIPTION -Initiates the move of an Office 365 Group site to a new geo location. The administrator may set a preferred start and end time for the move, however the preferred end time is not guaranteed. The customer tenant must be Multi-Geo enabled to use these commandlets. +Initiates the move of an Office 365 Group site to a new geo location. The administrator may set a preferred start and end time for the move, however the preferred end time is not guaranteed. The customer tenant must be Multi-Geo enabled to use these commandlets. ## EXAMPLES @@ -43,7 +46,7 @@ Starts the move of an Office 365 Group site with an alias EUTeam to the Preferre The destination location for the Office 365 Group site move. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -56,10 +59,10 @@ Accept wildcard characters: False ### -Force -Force the cmdlet to run. This ignores all warning blocks and validations. It is only recommended if the administrator only wishes to preserve data and is not interested in checks for applications, Business Connectivity Services, or other functionalities. +Force the cmdlet to run. This ignores all warning blocks and validations. It is only recommended if the administrator only wishes to preserve data and is not interested in checks for applications, Business Connectivity Services, or other functionalities. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -75,7 +78,7 @@ Accept wildcard characters: False The alias of the Office 365 Group attached to the site you want to move. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -91,7 +94,7 @@ Accept wildcard characters: False The move will likely begin at this specified time. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: @@ -107,7 +110,7 @@ Accept wildcard characters: False The move will likely be completed by this specified time, on a best effort basis. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: @@ -123,7 +126,7 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -139,7 +142,7 @@ Accept wildcard characters: False Suppress all warning messages. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -155,7 +158,7 @@ Accept wildcard characters: False Suppress checking for Business Connectivity Services used with the associated Office 365 Group site. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -171,7 +174,7 @@ Accept wildcard characters: False Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated Office 365 Group site. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -187,7 +190,7 @@ Accept wildcard characters: False Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated Office 365 Group site. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -203,7 +206,7 @@ Accept wildcard characters: False This parameter will force the cmdlet to execute only validation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -216,7 +219,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -230,4 +233,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Move a SharePoint site to a different geo location](https://learn.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations) +[Move a SharePoint site to a different geo location](/office365/enterprise/move-sharepoint-between-geo-locations) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md similarity index 83% rename from sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md index b155f9f83..4c5c5472c 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOUserAndContentMove.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/start-spouserandcontentmove applicable: SharePoint Online @@ -18,15 +18,15 @@ Starts the ability to move a user closer to their sites. ## SYNTAX -```powershell +``` Start-SPOUserAndContentMove [-UserPrincipalName] [-DestinationDataLocation] - [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] - [[-Notify] ] [[-Reserved] ] [-ValidationOnly] [] + [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [[-Notify] ] + [[-Reserved] ] [-ValidationOnly] [] ``` ## DESCRIPTION -This cmdlet applies to Multi-Geo tenants and it is designed to move user profiles and their corresponding OneDrive personal sites across geo locations. These cmdlets may only be run by a SharePoint administrator or above, who is connected to the SharePoint administration center of the geo location where the user is currently hosted. +This cmdlet applies to Multi-Geo tenants and it is designed to move user profiles and their corresponding OneDrive personal sites across geo locations. These cmdlets may only be run by a SharePoint administrator or above, who is connected to the SharePoint administration center of the geo location where the user is currently hosted. ## EXAMPLES @@ -52,16 +52,16 @@ This example moves the user username@contoso.onmicrosoft.com from their current Start-SPOUserAndContentMove -UserPrincipalName username@contoso.onmicrosoft.com -DestinationDataLocation EUR -PreferredMoveBeginDate ((Get-Date).AddHours(1)) -PreferredMoveEndDate ((Get-Date).AddHour(12)) ``` -This example moves the user username@contoso.onmicrosoft.com from their current location, to the European location (EUR), with a preferred start move date. Doing so is recommended for administrators who wish to plan their user moves outside business hours and on weekends. +This example moves the user username@contoso.onmicrosoft.com from their current location, to the European location (EUR), with a preferred start move date. Doing so is recommended for administrators who wish to plan their user moves outside business hours and on weekends. ## PARAMETERS ### -DestinationDataLocation -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. +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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -78,13 +78,13 @@ Accept wildcard characters: False Provides an SPO notification that the user is being moved. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: 6 +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -92,10 +92,10 @@ Accept wildcard characters: False ### -PreferredMoveBeginDate -Specifies what is the preferred date and time to begin the move. +Specifies what is the preferred date and time to begin the move. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -109,10 +109,10 @@ Accept wildcard characters: False ### -PreferredMoveEndDate -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. +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: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -124,12 +124,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Reserved +{{ Fill Reserved Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UserPrincipalName UserPrincipalName or UPN defined for the specific user on the SPO tenant ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -143,16 +158,16 @@ Accept wildcard characters: False ### -ValidationOnly -Use this parameter to validate if the user is able to be moved. This parameter is recommended for any user move. +Use this parameter to validate if the user is able to be moved. This parameter is recommended for any user move. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: False -Position: 8 +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -162,9 +177,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOAuditDataCollectionForActivityInsights.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOAuditDataCollectionForActivityInsights.md index 083c476d0..98140aa2e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOAuditDataCollectionForActivityInsights.md @@ -1,5 +1,5 @@ ---- -external help file: sharepointonline.xml +--- +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/stop-spoauditdatacollectionforactivityinsights applicable: SharePoint Online @@ -7,7 +7,7 @@ title: Stop-SPOAuditDataCollectionForActivityInsights schema: 2.0.0 author: pvrk ms.author: pullabhk -manager: +manager: ms.reviewer: --- @@ -47,7 +47,7 @@ This example will stop collecting audit data related to the generation of 'Anyon Specifies the entity for which the corresponding audit data should not be collected. ```yaml -Type: OptInReportEntityEnum +Type: Microsoft.Online.SharePoint.TenantAdministration.OptInReportEntityEnum Parameter Sets: (All) Aliases: Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights @@ -60,8 +60,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantGroupContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantGroupContentMove.md new file mode 100644 index 000000000..d8623e407 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantGroupContentMove.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Stop-SPOCrossTenantGroupContentMove + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Stop-SPOCrossTenantGroupContentMove [-SourceGroupAlias] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SourceGroupAlias +{{ Fill SourceGroupAlias Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantSiteContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantSiteContentMove.md new file mode 100644 index 000000000..d812803cb --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantSiteContentMove.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Stop-SPOCrossTenantSiteContentMove + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Stop-SPOCrossTenantSiteContentMove [-SourceSiteUrl] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SourceSiteUrl +{{ Fill SourceSiteUrl Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantUserContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantUserContentMove.md new file mode 100644 index 000000000..de19d8159 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOCrossTenantUserContentMove.md @@ -0,0 +1,61 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: +schema: 2.0.0 +--- + +# Stop-SPOCrossTenantUserContentMove + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Stop-SPOCrossTenantUserContentMove [-SourceUserPrincipalName] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SourceUserPrincipalName +{{ Fill SourceUserPrincipalName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOSiteContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOSiteContentMove.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOSiteContentMove.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOSiteContentMove.md index 64c248d8a..08921a1b4 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOSiteContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOSiteContentMove.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/stop-spositecontentmove applicable: SharePoint Online @@ -18,8 +18,8 @@ Stops a job to move a particular user or group of users to be moved across geo l ## SYNTAX -```powershell -Stop-SPOSiteContentMove [-SourceSiteUrl] [] +``` +Stop-SPOSiteContentMove [-SourceSiteUrl] [] ``` ## DESCRIPTION @@ -43,7 +43,7 @@ This example stops the move job for the specified site. Specifies the source URL of the site collection. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: True @@ -55,7 +55,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOTenantRename.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOTenantRename.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md index 819053bd5..d59cb60ad 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOTenantRename.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOTenantRename.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/stop-spotenantrename applicable: SharePoint Online @@ -17,15 +17,15 @@ ms.reviewer: > [!IMPORTANT] > This feature is currently available to organizations that have no more than 10,000 total SharePoint sites and OneDrive accounts combined. -Cancels the scheduled job to change the SharePoint domain name for your organization in Microsoft 365. +Cancels the scheduled job to change the SharePoint domain name for your organization in Microsoft 365. > [!NOTE] > If the job to change the SharePoint domain name is already in progress, then it cannot be canceled or stopped. ## SYNTAX -```Powershell -Stop-SPOTenantRename -Reason [-Comment ] [] +``` +Stop-SPOTenantRename -Reason [-Comment ] [] ``` ## DESCRIPTION @@ -44,34 +44,35 @@ Cancels the rename of the SharePoint domain name with the reason "Rescheduling". ## PARAMETERS -### -Reason +### -Comment -Specifies the reason why the job is being canceled. +Specifies an additional comment why the job is being canceled. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Comment +### -Reason -Specifies an additional comment why the job is being canceled. +Specifies the reason why the job is being canceled. ```yaml -Type: String +Type: System.String Parameter Sets: (All) +Aliases: Applicable: SharePoint Online -Required: False -Position: 2 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -81,9 +82,19 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Rename your SharePoint domain](https://aka.ms/SPOTenantRename) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md similarity index 92% rename from sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md index 166c5ddb0..2afc46839 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Stop-SPOUserAndContentMove.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/stop-spouserandcontentmove applicable: SharePoint Online @@ -18,7 +18,7 @@ In a Multi-Geo company, stops the ability to move a user's content related objec ## SYNTAX -```powershell +``` Stop-SPOUserAndContentMove [-UserPrincipalName] [] ``` @@ -51,7 +51,7 @@ Equivalent to the one above UserPrincipalName or UPN defined for the specific user on the SPO tenant ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -67,6 +67,16 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + ## RELATED LINKS [Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md similarity index 89% rename from sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md index 2765d2d4c..0aca96457 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Submit-SPOMigrationJob.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/submit-spomigrationjob applicable: SharePoint Online @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS -**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](https://learn.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets). +**Note**: This cmdlet has been deprecated. To migrate to SharePoint and Microsoft 365 using PowerShell, see [Migrate to SharePoint using PowerShell](/sharepointmigration/overview-spmt-ps-cmdlets). Cmdlet to submit a new migration job referenced to a previously uploaded package in Azure Blob storage into to a site collection. @@ -22,19 +22,17 @@ Cmdlet to submit a new migration job referenced to a previously uploaded package ## SYNTAX ### AzureLocationsInline - -```powershell +``` Submit-SPOMigrationJob [-TargetWebUrl] [-FileContainerUri] [-PackageContainerUri] - [-AzureQueueUri ] -Credentials - [-EncryptionParameters ] [-NoLogFile] [] + [-AzureQueueUri ] -Credentials [-NoLogFile] + [-EncryptionParameters ] [] ``` ### AzureLocationsPipebind - -```powershell +``` Submit-SPOMigrationJob [-TargetWebUrl] [-MigrationPackageAzureLocations] -Credentials - [-EncryptionParameters ] [-NoLogFile] [] + [-NoLogFile] [-EncryptionParameters ] [] ``` ## DESCRIPTION @@ -45,7 +43,7 @@ This cmdlet returns a GUID value which represents the MigrationJobId, or returns ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Submit-SPOMigrationJob -TargetUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -FileContainerUri "https://migrationstore.blob.core.windows.net/migration-files?sv=2014-02-14&sr=c&sig=THTTJoeGHysxRLgv22j473XYS2blH1YAVIdsfWrPhq8=&se=2015-04-06T05:09:36Z&sp=rl" -PackageContainerUri "https://migrationstore.blob.core.windows.net/migration-package?sv=2014-02-14&sr=c&sig=2PCBJtiXsVWiK5GrY7jBEdyEAwtunQNJLH8uo6I0+Ew=&se=2015-04-06T05:09:37Z&sp=rwl" @@ -53,7 +51,7 @@ Submit-SPOMigrationJob -TargetUrl https://contoso.sharepoint.com/sites/TargetSit This example creates a new migration job in the target site collection for the web at the URL ' The migration job includes information about the file and package metadata Azure Storage containers that are passed into the command. -### -----------------------EXAMPLE 2----------------------------- +### EXAMPLE 2 ```powershell Submit-SPOMigrationJob -TargetUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -MigrationPackageAzureLocations $azurelocations @@ -68,7 +66,7 @@ This example creates a new migration job in the target site collection for the w An optional fully qualified URL and SAS token representing the Azure Storage Reporting Queue where import operations will list events during import. ```yaml -Type: String +Type: System.String Parameter Sets: AzureLocationsInline Aliases: Applicable: SharePoint Online @@ -85,7 +83,7 @@ Accept wildcard characters: False 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: CredentialCmdletPipeBind +Type: Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -99,10 +97,10 @@ Accept wildcard characters: False ### -EncryptionParameters -An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](https://learn.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. +An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. ```yaml -Type: EncryptionParameters +Type: Microsoft.Online.SharePoint.Migration.EncryptionParameters Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -119,7 +117,7 @@ Accept wildcard characters: False A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package content files. ```yaml -Type: String +Type: System.String Parameter Sets: AzureLocationsInline Aliases: Applicable: SharePoint Online @@ -136,7 +134,7 @@ Accept wildcard characters: False 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: MigrationPackageAzureLocations +Type: Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations Parameter Sets: AzureLocationsPipebind Aliases: Applicable: SharePoint Online @@ -153,7 +151,7 @@ Accept wildcard characters: False Indicates to not create a log file. The default is to create a new CreateMigrationJob log file within the current directory. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -170,7 +168,7 @@ Accept wildcard characters: False A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package metadata files. ```yaml -Type: String +Type: System.String Parameter Sets: AzureLocationsInline Aliases: Applicable: SharePoint Online @@ -187,7 +185,7 @@ Accept wildcard characters: False 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: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md similarity index 82% rename from sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md index ed00ee015..e94837547 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Test-SPOSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/test-sposite applicable: SharePoint Online @@ -18,7 +18,7 @@ Tests a SharePoint Online site collection. ## SYNTAX -```powershell +``` Test-SPOSite -Identity [-RuleId ] [-RunAlways] [] ``` @@ -30,11 +30,11 @@ This cmdlet reports the rules together with a summary of the results. You must be at least a SharePoint administrator to run the cmdlet. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Test-SPOSite https://contoso.sharepoint.com/sites/marketing @@ -49,7 +49,7 @@ This example runs all the site collection health checks on the -JustificationText +``` +Unlock-SPOSensitivityLabelEncryptedFile [-FileUrl] [-JustificationText] [] ``` ## DESCRIPTION @@ -28,17 +28,17 @@ The `Unlock-SPOSensitivityLabelEncryptedFile` cmdlet runs on a single office onl You must be at least a SharePoint Online administrator to run the `Unlock-SPOSensitivityLabelEncryptedFile` cmdlet. This cmdlet doesn't work on files that have double key encryption or files that have encryption but are not processed by SharePoint. These files don't show the name of the label in the Sensitivity column, and you can't edit these files in Office Online. -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). +For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES -### -----------------------EXAMPLE 1----------------------------- +### EXAMPLE 1 ```powershell Unlock-SPOSensitivityLabelEncryptedFile -FileUrl "https://contoso.com/sites/Marketing/Shared Documents/Doc1.docx" -JustificationText "Need to recover this file" ``` -This example will remove a regular label with admin defined encryption from the file Doc1.docx and also make an entry in audit logs. +This example will remove a regular label with admin defined encryption from the file Doc1.docx and also make an entry in audit logs. ## PARAMETERS @@ -47,39 +47,50 @@ This example will remove a regular label with admin defined encryption from the Full URL for the file. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None +Accept pipeline input: False +Accept wildcard characters: False ``` ### -JustificationText -Text that explains the reason to run this cmdlet on the given file. +Text that explains the reason to run this cmdlet on the given file. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online Required: True -Position: Named +Position: 1 Default value: None +Accept pipeline input: False +Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS +### None + ## OUTPUTS +### System.Object + ## NOTES ## RELATED LINKS -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md similarity index 72% rename from sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md index db9b88ce2..61de5869f 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Unregister-SPOHubSite.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/unregister-spohubsite applicable: SharePoint Online @@ -18,8 +18,8 @@ Disables the hub site feature on a site. ## SYNTAX -```powershell -Unregister-SPOHubSite [-Identity] [-WhatIf] [-Confirm] [] +``` +Unregister-SPOHubSite [-Identity] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,31 +49,46 @@ This example disables the hub feature on the marketing site. ## PARAMETERS +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity 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: SpoHubSitePipeBind +Type: Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind Parameter Sets: (All) Aliases: HubSite Applicable: SharePoint Online Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf +### -Confirm -Shows what would happen if the cmdlet runs. The cmdlet is not run. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Applicable: SharePoint Online Required: False @@ -83,14 +98,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Applicable: SharePoint Online Required: False @@ -101,5 +116,16 @@ Accept wildcard characters: False ``` ### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Online.SharePoint.PowerShell.SpoHubSitePipeBind + +## OUTPUTS + +### System.Object + +## NOTES -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-SPODataEncryptionPolicy.md similarity index 67% rename from sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-SPODataEncryptionPolicy.md index c522a4821..7bad4d8fa 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-SPODataEncryptionPolicy.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/update-spodataencryptionpolicy applicable: SharePoint Online @@ -18,14 +18,22 @@ Updates customer encryption status for a geo tenant. ## SYNTAX -```powershell -Update-SPODataEncryptionPolicy [-KeyVaultName] [-KeyName] [-KeyVersion] [-KeyType] [-WhatIf] [-Confirm] [] +### BYOK_MultipleParameters (Default) +``` +Update-SPODataEncryptionPolicy -KeyVaultName -KeyName -KeyVersion + -KeyType [-WhatIf] [-Confirm] [] +``` + +### BYOK_Uri +``` +Update-SPODataEncryptionPolicy -KeyVaultUri -KeyType [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION Use the Update-SPODataEncryptionPolicy cmdlet to update customer encryption status for your geo tenant. -For more information, see [Controlling your data in Office 365 using Customer Key](https://learn.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) +For more information, see [Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) ## EXAMPLES @@ -39,29 +47,13 @@ This example updates the DEP used with SharePoint Online and OneDrive for Busine ## PARAMETERS -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -KeyName The name of the key ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters Aliases: Required: True @@ -79,10 +71,10 @@ The type of the key, possible values are - Secondary ```yaml -Type: CustomerKeyVaultKeyType +Type: Microsoft.SharePoint.Client.CustomerKeyVaultKeyType Parameter Sets: (All) Aliases: -Accepted values: Primary, Secondary +Accepted values: Primary, Secondary, Availability Required: True Position: Named @@ -96,8 +88,23 @@ Accept wildcard characters: False The name of the Azure Key Vault Name ```yaml -Type: String -Parameter Sets: (All) +Type: System.String +Parameter Sets: BYOK_MultipleParameters +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultUri +{{ Fill KeyVaultUri Description }} + +```yaml +Type: System.Uri +Parameter Sets: BYOK_Uri Aliases: Required: True @@ -112,8 +119,8 @@ Accept wildcard characters: False The version of the key ```yaml -Type: Guid -Parameter Sets: (All) +Type: System.Guid +Parameter Sets: BYOK_MultipleParameters Aliases: Required: True @@ -123,13 +130,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -142,11 +165,11 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind +### None ## OUTPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Update-UserType.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md similarity index 86% rename from sharepoint/sharepoint-ps/sharepoint-online/Update-UserType.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md index 692af21e2..bc7ae3876 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Update-UserType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Update-UserType.md @@ -1,5 +1,5 @@ --- -external help file: sharepointonline.xml +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/update-usertype applicable: SharePoint Online @@ -18,7 +18,7 @@ Updates the specified user's UserType value from Microsoft Entra ID. ## SYNTAX -```powershell +``` Update-UserType [-LoginName] [] ``` @@ -43,7 +43,7 @@ Updates the jdoe@contoso.com's UserType on all SharePoint Online sites in the te The login name of the target user to update across SharePoint Online. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Applicable: SharePoint Online @@ -57,7 +57,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -71,4 +71,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Properties of a Microsoft Entra B2B collaboration user](https://learn.microsoft.com/azure/active-directory/b2b/user-properties) +[Properties of a Microsoft Entra B2B collaboration user](/azure/active-directory/b2b/user-properties) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Verify-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Verify-SPOCrossTenantRelationship.md similarity index 56% rename from sharepoint/sharepoint-ps/sharepoint-online/Verify-SPOTenantOrgRelation.md rename to sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Verify-SPOCrossTenantRelationship.md index 02bbddbaf..29d5ad532 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Verify-SPOTenantOrgRelation.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Verify-SPOCrossTenantRelationship.md @@ -1,34 +1,28 @@ --- -external help file: sharepointonline.xml +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/Verify-SPOTenantOrgRelation -applicable: SharePoint Online -title: Verify-SPOTenantOrgRelation +online version: schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: --- -# Verify-SPOTenantOrgRelation -## SYNOPSIS +# Verify-SPOCrossTenantRelationship -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. +## SYNOPSIS +{{ Fill in the Synopsis }} ## SYNTAX -```powershell -Verify-SPOTenantOrgRelation [-Scenario] [-PartnerRole] [-PartnerCompanyId] [-PartnerInstanceId ] [] +``` +Verify-SPOCrossTenantRelationship [-Scenario] [-PartnerRole] + [-PartnerCrossTenantHostUrl] [] ``` ## DESCRIPTION - {{ Fill in the Description }} ## EXAMPLES ### Example 1 - ```powershell PS C:\> {{ Add example code here }} ``` @@ -37,12 +31,11 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} +### -PartnerCrossTenantHostUrl +{{ Fill PartnerCrossTenantHostUrl Description }} ```yaml -Type: Guid +Type: System.String Parameter Sets: (All) Aliases: @@ -53,28 +46,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PartnerInstanceId - -{{ Fill PartnerInstanceId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PartnerRole - {{ Fill PartnerRole Description }} ```yaml -Type: OrgRelationRole +Type: Microsoft.SharePoint.Client.Administration.OrgRelationRole Parameter Sets: (All) Aliases: Accepted values: None, Source, Target @@ -87,11 +63,10 @@ Accept wildcard characters: False ``` ### -Scenario - {{ Fill Scenario Description }} ```yaml -Type: OrgRelationScenario +Type: Microsoft.SharePoint.Client.Administration.OrgRelationScenario Parameter Sets: (All) Aliases: Accepted values: None, MnA @@ -104,8 +79,7 @@ Accept wildcard characters: False ``` ### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Disable-SPOTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-online/Disable-SPOTenantServicePrincipal.md deleted file mode 100644 index 8bb1bb10f..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Disable-SPOTenantServicePrincipal.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/disable-spotenantserviceprincipal -applicable: SharePoint Online -title: Disable-SPOTenantServicePrincipal -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Disable-SPOTenantServicePrincipal - -## SYNOPSIS - -Disables the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Disable-SPOTenantServicePrincipal -``` - -## DESCRIPTION - -Disables the current tenant's "SharePoint Online Client" service principal. - -When the service principal's account is disabled, clients and components that use this service principal -will not be able to request an access token for this service principal. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -Disable-SPOTenantServicePrincipal -``` - -Disables the current tenant's "SharePoint Online Client" service principal. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoOptInStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoOptInStatus.md deleted file mode 100644 index 06db8f673..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoOptInStatus.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Get-SPOCopilotPromoOptInStatus -applicable: SharePoint Online -title: Get-SPOCopilotPromoOptInStatus -schema: -author: siruvanti -ms.author: siruvanti -ms.reviewer: ---- - -# Get-SPOCopilotPromoOptInStatus - -## SYNOPSIS - -Returns the Opt-In Copilot promo status for the tenant. - -## SYNTAX -```powershell -Get-SPOCopilotPromoOptInStatus -``` - -## DESCRIPTION - -This cmdlet returns the Opt-In Copilot promo status for the tenant. -If the promo status is enabled, the return value is `True`, otherwise the return value is `False`. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOCopilotPromoOptInStatus -``` - -Example 1 returns the value of the Opt-In promo status. - -## RELATED LINKS -- [Set-SPOCopilotPromoOptInStatus](./Set-SPOCopilotPromoOptInStatus.md) -- [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoUsage.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoUsage.md deleted file mode 100644 index 5c37365ba..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoUsage.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Get-SPOCopilotPromoUsage -applicable: SharePoint Online -title: Get-SPOCopilotPromoUsage -schema: -author: arakesh -ms.author: arakesh -ms.reviewer: ---- - -# Get-SPOCopilotPromoUsage - -## SYNOPSIS - -Returns the count of SharePoint Agent promotion queries used by the tenant. - -## SYNTAX -```powershell -Get-SPOCopilotPromoUsage -``` - -## DESCRIPTION - -This cmdlet retrieves the number of SharePoint Agent promotion queries used by the tenant each month, starting the month tenant qualified for trial. -It provides a monthly breakdown of query usage, helping admins track consumption of the promotion queries over time. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOCopilotPromoUsage -``` - -Example 1 returns SharePoint Agent promotion queries usage by month. - -## RELATED LINKS -- [Get-SPOCopilotPromoOptInStatus](./Get-SPOCopilotPromoOptInStatus.md) -- [Set-SPOCopilotPromoOptInStatus](./Set-SPOCopilotPromoOptInStatus.md) -- [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.md deleted file mode 100644 index 1525802db..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPODataConnectionSetting.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/new-spodataconnectionsetting -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: New-SPODataConnectionSetting -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPODataConnectionSetting - -## SYNOPSIS - -Creates a new Business Data Connectivity service connection. - -## SYNTAX - -```powershell -New-SPODataConnectionSetting -AuthenticationMode -ServiceAddressURL - -ServiceContext -Name [-AssignmentCollection ] - [-ExtensionProvider ] [-SecureStoreTargetApplicationId ] [] -``` - -## DESCRIPTION - -Use the `New-SPODataConnectionSetting` cmdlet to create a new Business Data Connectivity service connection and its associated metadata properties in the farm. -To see the metadata settings, use the `Get-SPODataConnectionSettingMetaData` cmdlet. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at ( - -## EXAMPLES - -### ------------------EXAMPLE------------------ - -```powershell -New-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso" -ServiceAddressURL "https://expensereporting.cloudapp.net/expensereporting.svc" -AuthenticationMode "Credentials" -SecureStoreTargetApplicationId "DallasUserName" -``` - -This example creates a new Business Data Connectivity service connection named ContosoServiceApp. - -In this process, a Microsoft Business Connectivity Services connection metadata object is created. - -## PARAMETERS - -### -AuthenticationMode - -Specifies the type of authentication mode required for the Business Connectivity Services connection. - -The value for the authentication mode is any one of the following options: - -```yaml -Type: ODataAuthenticationMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAddressURL - -Specifies the URL for the OData service. -The URL does not have be Internet facing. -This is the final destination from which data is retrieved. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceContext - -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the Business Connectivity Services connection object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ExtensionProvider - -Specifies the ODataExtensionProvider for the Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureStoreTargetApplicationId - -Specifies the Secure Store Target Application ID. -Works in conjunction with the AuthenticationMode parameter. - -The value for the SecureStoreTargetApplicationId parameter is any one of the following options: - ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPODataConnectionSetting](xref:SharePointServer.Get-SPODataConnectionSetting) - -[Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) - -[Set-SPODataConnectionSetting](Set-SPODataConnectionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md deleted file mode 100644 index b052f959e..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/new-sponlineapplicationprincipalmanagementserviceapplicationproxy -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy - -## SYNOPSIS - -Creates a new SharePoint Online management Application Proxy Name - -## SYNTAX - -```powershell -New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy - [-AssignmentCollection ] [-Confirm] [-DefaultProxyGroup] -Name - -OnlineTenantUri [-WhatIf] [] -``` - -## DESCRIPTION - -This Cmdlet is used to create a new Application Proxy name, for example usually when you run [this script](https://www.microsoft.com/en-us/download/confirmation.aspx?id=51490) you onboard your SharePoint Online (SPO) tenant and your SharePoint server cloud SSA to cloud hybrid search. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy -Name $SPO_MANAGEMENT_APPPROXY_NAME -OnlineTenantUri $PortalUrl -DefaultProxyGroup -``` - -Found the proxies for the tenant on the variable $PortalUrl on the Default Proxy Group. - -## PARAMETERS - -### -AssignmentCollection - -After the creation of the new Principal Management Service Application proxy assign it to the collection. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultProxyGroup - -Search Proxies on the default Proxy Group - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -SPO Management AppProxy Name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OnlineTenantUri - -Define the online Tenant URI. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://support.office.com/en-us/article/introduction-to-the-sharepoint-online-management-shell-c16941c3-19b4-4710-8056-34c034493429) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) - -[Full Download to Hybrid Scripts](https://www.microsoft.com/en-us/download/confirmation.aspx?id=51490) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.md deleted file mode 100644 index ea18fe254..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODataConnectionSetting.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/remove-spodataconnectionsetting -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Remove-SPODataConnectionSetting -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPODataConnectionSetting - -## SYNOPSIS - -Removes a Business Connectivity Services connection. - -## SYNTAX - -### Identity - -```powershell -Remove-SPODataConnectionSetting [-Identity] - -ServiceContext [-AssignmentCollection ] [-Confirm] - [-WhatIf] [] -``` - -### Name - -```powershell -Remove-SPODataConnectionSetting -ServiceContext -Name - [-AssignmentCollection ] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see [Cmdlet parameter sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). - -Use the `Remove-SPODataConnectionSetting` cmdlet to remove a Business Connectivity Services connection for a particular Business Connectivity Services service application in the farm. - -The metadata object associated with the Business Connectivity Services connection is also deleted. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://go.microsoft.com/fwlink/p/?LinkId=251831). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Remove-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp" -``` - -This example removes the Business Connectivity Services connection named ContosoServiceApp. -Metadata properties are also removed. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Remove-SPODataConnectionSetting -ServiceContext "http://contoso" -Name "ContosoServiceApp-metadata" -``` - -This example removes the Business Connectivity Services connection metadata named ContosoServiceApp. - -The associated Business Connectivity Services connection object is also removed. - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -$ConnectionVariable = Get-SPODataConnectionSettingMetadata -ServiceContext http://contoso -Name "ContosoServiceApp" - -Remove-SPODataConnectionSetting -Identity $ConnectionVariable -ServiceContext "http://contoso" -``` - -This example removes the Business Connectivity Services and its associated metadata connection named ContosoServiceApp. - -## PARAMETERS - -### -Identity - -Specifies the OData Connection Settings object. - -```yaml -Type: ODataConnectionSettings -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext - -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the existing Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -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` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPODataConnectionSetting](../sharepoint-server/Get-SPODataConnectionSetting.md) - -[New-SPODataConnectionSetting](New-SPODataConnectionSetting.md) - -[Set-SPODataConnectionSetting](Set-SPODataConnectionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.md deleted file mode 100644 index 8d9387804..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSetting.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/set-spodataconnectionsetting -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Set-SPODataConnectionSetting -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPODataConnectionSetting - -## SYNOPSIS - -Sets or updates global properties for a Microsoft Business Connectivity Services connection. - -## SYNTAX - -### Identity - -```powershell -Set-SPODataConnectionSetting [-Identity] -ServiceContext - [-AssignmentCollection ] [-AuthenticationMode ] [-Confirm] - [-ExtensionProvider ] [-SecureStoreTargetApplicationId ] [-ServiceAddressURL ] [-WhatIf] - [] -``` - -### Name - -```powershell -Set-SPODataConnectionSetting -ServiceContext -Name - [-AssignmentCollection ] [-AuthenticationMode ] [-Confirm] - [-ExtensionProvider ] [-SecureStoreTargetApplicationId ] [-ServiceAddressURL ] [-WhatIf] - [] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see [Cmdlet parameter sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). - -Use the `Set-SPODataConnectionSetting` cmdlet to update the properties of an existing connection for a specific Business Connectivity Services service application. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at ( - -## EXAMPLES - -### -------------EXAMPLE 1----------- - -```powershell -Set-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso" -AuthenticationMode "PassThrough" -``` - -This example updates the properties of Business Connectivity Services connection named ContosoServiceApp. - -### -------------EXAMPLE 2----------- - -```powershell -$ConnectionVariable = Get-SPODataConnectionSetting -ServiceContext http://contoso -Name "ContosoServiceApp" - -Set-SPODataConnectionSetting -Identity $ConnectionVariable -AuthenticationMode "PassThrough" -``` - -This example updates the properties of the Business Connectivity Services service connection named ContosoServiceApp. - -### -------------EXAMPLE 3----------- - -```powershell -Set-SPODataConnectionSetting -Name "ContosoServiceApp" -ServiceContext "http://contoso" -AuthenticationMode "PassThrough" -ExtensionProvider "" -``` - -This example updates the properties of Business Connectivity Services connection named ContosoServiceApp, the authentication mode has been changed and extension provider value has been cleared. - -## PARAMETERS - -### -Identity - -Specifies the OData Connection Settings object. - -```yaml -Type: ODataConnectionSettings -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext - -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or a SPSite object: An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the existing Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationMode - -Specifies the type of authentication mode that is required for the Business Connectivity Services connection. - -The value for the authentication mode is any one of the following options: - ---PassThrough ---RevertToSelf ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate ---Anonymous - -```yaml -Type: ODataAuthenticationMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionProvider - -Specifies the ODataExtensionProvider for the Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureStoreTargetApplicationId - -Specifies the Secure Store Target Application ID. -Works in conjunction with the AuthenticationMode parameter. - -The value for the SecureStoreTargetApplicationId parameter is any one of the following options: - ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAddressURL - -Specifies the URL for the OData service. -The URL does not have to be Internet facing. -This is the final destination from which data is retrieved. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -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` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPODataConnectionSetting](xref:SharePointServer.Get-SPODataConnectionSetting) - -[New-SPODataConnectionSetting](New-SPODataConnectionSetting.md) - -[Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md deleted file mode 100644 index 13686ab12..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/set-spodataconnectionsettingmetadata -applicable: SharePoint Server 2013, SharePoint Server 2016 -title: Set-SPODataConnectionSettingMetadata -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPODataConnectionSettingMetadata - -## SYNOPSIS - -Updates properties for the metadata of a Business Connectivity Services connection. - -## SYNTAX - -### Identity - -```powershell -Set-SPODataConnectionSettingMetadata [-Identity] -ServiceContext [-AssignmentCollection ] [-AuthenticationMode ] [-Confirm] [-SecureStoreTargetApplicationId ] [-ServiceAddressMetadataURL ] [-WhatIf] [] -``` - -### Name - -```powershell -Set-SPODataConnectionSettingMetadata -ServiceContext -Name [-AssignmentCollection ] [-AuthenticationMode ] [-Confirm] [-SecureStoreTargetApplicationId ] [-ServiceAddressMetadataURL ] [-WhatIf] [] -``` - -## DESCRIPTION - -This cmdlet contains more than one parameter set. -You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. -For more information about how to use parameter sets, see [Cmdlet parameter sets](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). - -Use the `Set-SPODataConnectionSettingMetaData` cmdlet to update properties for a Business Connectivity Services connection for a Business Connectivity Services service application in the farm. - -This cmdlet applies to an on-premises environment only. -You cannot use this command in the SharePoint Online Management Shell. - -For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at [SharePoint Server Cmdlets](https://learn.microsoft.com/powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets). - -## EXAMPLES - -### --------------EXAMPLE 1------------- - -```powershell -Set-SPODataConnectionSettingMetadata -Name "ContosoServiceApp" -ServiceContext "http://contoso" -AuthenticationMode "PassThrough" -``` - -This example updates the authentication mode of the metadata of Business Connectivity Services connection named ContosoServiceApp. - -### --------------EXAMPLE 2------------- - -```powershell -$ConnectionVariable = Get-SPODataConnectionSettingMetadata -ServiceContext http://contoso -Name "ContosoServiceApp" - -Set-SPODataConnectionSettingMetadata -Identity $ConnectionVariable -AuthenticationMode "PassThrough" -``` - -This example updates the Metadata properties of the Business Connectivity Services connection named ContosoServiceApp. - -## PARAMETERS - -### -Identity - -Specifies the OData Connection Settings object. - -```yaml -Type: ODataConnectionSettings -Parameter Sets: Identity -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServiceContext - -Specifies the service context which is in the form of an instance of an SPServiceContext object, an SPSiteAdministration object identifier, or an SPSite object. -An example of a service context value is an identifier from the ID field, a string identifier, a URI, or a string representation of a GUID. - -```yaml -Type: SPServiceContextPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the existing Business Connectivity Services connection. - -```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AssignmentCollection - -Manages objects for the purpose of proper disposal. -Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. -Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. -When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used. - -When the Global parameter is used, all objects are contained in the global store. -If objects are not immediately used, or disposed of by using the `Stop-SPAssignment` command, an out-of-memory scenario can occur. - -```yaml -Type: SPAssignmentCollection -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AuthenticationMode - -Specifies the type of authentication mode that the Business Connectivity Services connection requires. - -The value for the authentication mode is any one of the following options: - ---PassThrough ---RevertToSelf ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate ---Anonymous - -```yaml -Type: ODataAuthenticationMode -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. -For more information, type the following command: `get-help about_commonparameters` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureStoreTargetApplicationId - -Specifies the Secure Store Target Application ID. -Works in conjunction with the AuthenticationMode parameter. - -The value for the SecureStoreTargetApplicationId parameter is any one of the following options: - ---Credentials ---WindowsCredentials ---DigestCredentials ---ClientCertificate - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAddressMetadataURL - -Specifies the metadata URL for the OData service. -This URL does not have to be Internet facing. -If a value is not specified for a connection, a default value is used. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -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` - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Server 2013, SharePoint Server 2016 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Upgrade-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Upgrade-SPOSite.md deleted file mode 100644 index ce8011cc3..000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Upgrade-SPOSite.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://learn.microsoft.com/powershell/module/sharepoint-online/upgrade-sposite -applicable: SharePoint Online -title: Upgrade-SPOSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Upgrade-SPOSite - -## SYNOPSIS - -Starts the upgrade process on a site collection. - -## SYNTAX - -```powershell -Upgrade-SPOSite [-Confirm] -Identity [-NoEmail] [-QueueOnly] [-VersionUpgrade] [-WhatIf] - [] -``` - -## DESCRIPTION - -The `Upgrade-SPOSite` cmdlet activates the upgrade process for the specified SharePoint Online site collection. -This cmdlet can also be used to resume failed upgrades. - -When upgrade is initiated, it can either be a build-to-build or version-to-version upgrade. -The default is build-to-build upgrade. -When in version-to-version upgrade, site collection health checks are first run in repair mode to ensure that the site collection can be upgraded successfully. - -You must be at least a SharePoint Online administrator and be a site collection administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing -``` - -Example 1 runs a build-to-build upgrade of the existing site collection The CompatibilityLevel property associated with the site collection is not changed by this operation. For more information about CompatibilityLevel, see `New-SPOSite`. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Upgrade-SPOSite -Identity https://contoso.sharepoint.com/sites/marketing -VersionUpgrade -``` - -Example 2 runs a version-to-version upgrade of the existing site collection The CompatibilityLevel property associated with the site collection is changed to a value of SharePoint 2013 by this operation. For more information about CompatibilityLevel, see `New-SPOSite`. - -## PARAMETERS - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the SharePoint Online site collection to upgrade. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoEmail - -Specifies that the system not send the requester and site collection administrators a notification e-mail message at the end of the upgrade process. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueOnly - -Adds the site collection to the upgrade queue. The upgrade does not occur immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionUpgrade - -Specifies whether to perform a version-to-version upgrade on the site collection. When this parameter is set, it internally triggers any available build-to-build upgrade associated with the current site collection operating mode and continues with version-to-version upgrade. When this parameter is not set, it triggers only build-to-build upgrade on the site collection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Request-SPOUpgradeEvaluationSite](Request-SPOUpgradeEvaluationSite.md) - -[New-SPOSite](New-SPOSite.md) From 3d7d0cfe0ac5a644c7201fdef7dfcaa0ac23ed3a Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 15 Jul 2025 13:33:36 -0500 Subject: [PATCH 2/3] Fix error in syntax block --- .../Get-SPOContainerType.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) 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 d727777a3..c250c74ce 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainerType.md @@ -20,21 +20,24 @@ Returns one or more container types created in the tenant. ### ParamSet1 -```powershell -Get-SPOContainerType [] ``` Get-SPOContainerType [[-ContainerTypeId] ] [] ``` ## DESCRIPTION -This cmdlet returns all the container types present in the tenant or details of a specific container type when paired with the `ContainerTypeId` parameter. +This cmdlet returns all the container types present in the tenant or details of a specific container +type when paired with the `ContainerTypeId` parameter. You must be a SharePoint Embedded Administrator to run the cmdlet. -While the basic information of container types is displayed to all administrators running this cmdlet, the billing information about a container type is only visible to administrators who also have owner or contributor access on the billing subscription attached to the container type. +While the basic information of container types is displayed to all administrators running this +cmdlet, the billing information about a container type is only visible to administrators who also +have owner or contributor access on the billing subscription attached to the container type. -For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). +For permissions and the most current information about Windows PowerShell for SharePoint Embedded +Containers, see the documentation at +[Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). ## EXAMPLES @@ -51,6 +54,7 @@ Example 1 retrieves all the container types present in the tenant and displays c ```powershell Get-SPOContainerType -ContainerTypeId 4f0af585 ``` + Example 2 returns the detailed properties of container type 4f0af585. ## PARAMETERS @@ -58,6 +62,7 @@ Example 2 returns the detailed properties of container type 4f0af585. ### -ContainerTypeId This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. + ```yaml Type: System.Guid Parameter Sets: (All) From 96891a6251bb24440dd2f646714a5981d030d5ea Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 15 Jul 2025 13:36:10 -0500 Subject: [PATCH 3/3] Add missing H2 --- .../Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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 218fd55c8..05993d6d0 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPOSite.md @@ -16,15 +16,17 @@ ms.reviewer: Sets or updates one or more properties' values for a site collection. -X +## SYNTAX ### None (Default) + ``` Set-SPOSite [-Identity] [-InformationBarriersMode ] [-WhatIf] [-Confirm] [] ``` ### ParamSet1 + ``` Set-SPOSite [-Identity] [-Owner ] [-Title ] [-StorageQuota ] [-StorageQuotaWarningLevel ] [-ResourceQuota ] [-ResourceQuotaWarningLevel ]